List Nodes

POST 
/registry-svc/nodes

Retrieve a list of nodes.

Request

application/json

Body

List Registrys Request

object

Responses

200

OK

application/json

Schema

Schema

nodes

object[]

Array [

availabilityZone string

The availability zone of the node

gpus

object[]

List of GPUs available on the node

Array [

busId string

computeMode string

gpuUtilization number

id string

Id Node.URL + IntraNodeId

intraNodeId integer

memoryTotal integer

memoryUsage integer

name string

performanceState string

powerCap number

powerUsage number

processDetails

object[]

Array [

memoryUsage integer

pid integer

processName string

]

temperature number

]

id stringrequired

Required: ID of the instance

lastHeartbeat string

Last time the instance gave a sign of life

region string

The region of the node

url stringrequired

URL of the daemon running on the node. If not configured defaults to hostname + default OpenOrch daemon port.

usage

object

cpu

object

CPU usage metrics.

percent number

Usage percentage.

total int64

Total available amount (in bytes).

used int64

Used amount (in bytes).

disk

object

Disk usage metrics.

percent number

Usage percentage.

total int64

Total available amount (in bytes).

used int64

Used amount (in bytes).

memory

object

Memory usage metrics.

percent number

Usage percentage.

total int64

Total available amount (in bytes).

used int64

Used amount (in bytes).

]

Example (from schema)

{
  "nodes": [
    {
      "availabilityZone": "string",
      "gpus": [
        {
          "busId": "string",
          "computeMode": "string",
          "gpuUtilization": 0,
          "id": "string",
          "intraNodeId": 0,
          "memoryTotal": 0,
          "memoryUsage": 0,
          "name": "string",
          "performanceState": "string",
          "powerCap": 0,
          "powerUsage": 0,
          "processDetails": [
            {
              "memoryUsage": 0,
              "pid": 0,
              "processName": "string"
            }
          ],
          "temperature": 0
        }
      ],
      "id": "node_di9riJEvH2",
      "lastHeartbeat": "string",
      "region": "string",
      "url": "string",
      "usage": {
        "cpu": {
          "percent": 0,
          "total": 0,
          "used": 0
        },
        "disk": {
          "percent": 0,
          "total": 0,
          "used": 0
        },
        "memory": {
          "percent": 0,
          "total": 0,
          "used": 0
        }
      }
    }
  ]
}

400

Invalid JSON

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...