Resources APIs

Get Clusters

• Description – Gets all clusters.

• Request URL – GET /cablevalidation/clusters

• Response Content Type – application/json

• Status Codes200 – OK

• Response Example 

  ["default"]

Get Data Halls

• Description – Get a list of all data halls

• Request URL – GET /cablevalidation/resources/data_halls

• Response Content Type – application/json

• Status Codes200 – OK

• Response Example 

  ["DH1", "DH2"]

Get Scalable Units

• Description –  Get a list of scalable units.

• Request URL – GET /cablevalidation/resources/scalable_units?data_hall=<data_hall_name>

• Params

• Response Content Type – application/json

• Status Codes200 – OK404 - NOT FOUND

• Response Example 

  ["SU1", "SU2"]

Get All Racks

• Description – Gets a list of rack names.

• Request URL – GET /cablevalidation/resources/racks?cluster=<cluster_name>

• Request Paramscluster: cluster nametype: stringoptional: yes

• Response Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND

• Response Example 

  ["PXX", "PXH"]

Get Rack

• Description – Gets a single rack by name.

• Request URL – GET /cablevalidation/resources/racks/<rack_name>?cluster=<cluster_name>

• Request Paramscluster: cluster nametype: stringoptional: yes

• Response Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND

• Response Example 

  {
    "name": "AAA",
    "port_type": "ib",
    "dh": "DH1",
    "su": "SU1",
    "units": [{
        "unit": "35",
        "nodedesc": "swx-ray09 mlx5_0",
        "nodetype": "Switch",
        "system_info": {
          "Manufacturer": "Nvidia",
          "Product Name": "Q3400_RA",
          "Version": "V0-F*Tb-L*GcNaEi-P*PaPa-O*Tb",
          "Serial Number": "MT2421X00988"
        },
        "device_health": {
          "Power Supply": {
            "Failed": 11,
            "Active": 1
          },
          "Power Supply Fans": {
            "Failed": 1,
            "Active": 1
          },
          "Fans": {
            "Failed": 0,
            "Active": 8
          }
        },
        "ports": [
          {
            "port": "sw26p1",
            "port_name": "",
            "syndrome": "Wrong-neighbor",
            "peer_port": "sw10p1",
            "peer_node": "x-spine-1"
          }]
  	}]
  }

Get Resource Utilization

• Description – Gets resource utilization.

• Request URL – GET  /cablevalidation/resources/resource_utilization

• Response Content Type – application/json

• Status Codes200 – OK

• Response Example 

  {
      "storage": {
          "space_total": "1.8T",
          "space_used": "156G",
          "space_available": "1.5T",
          "space_percent_used": "10%",
          "type": "ext4"
      },
      "memory": {
          "sys_mem_total": "125Gi",
          "sys_mem_used": "10Gi",
          "sys_mem_free": "71Gi",
          "sys_mem_used_percent": "8.24%",
          "swap_mem_total": "15Gi",
          "swap_mem_used": "0B",
          "swap_mem_free": "15Gi",
          "swap_mem_used_percent": "0.0%"
      },
      "cpu_util": {
          "timestamp": 1743960805.0907748,
          "cpu_util_all_cores": "1.43%",
          "cpu_util_current_core": "0.33%"
      }
  }

Last updated: May 14, 2025