Pods

Retrieve data about workload pods from your NVIDIA Run:ai platform.

List pods.

get

Retrieve a list of pods from a cluster.

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

sortBystring · enumOptional

Sort results using a parameter.

Possible values:

filterBystring[]Optional

Filter results using a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["nodeName!=some-node-name"]

verbositystring · enumOptional

response verbosity level. if full, the response includes workloadName and projectName fields.

Default: briefExample: fullPossible values:

completedstringOptional

Return only completed resources when 'true', return only non-completed resources when 'false'. By default, or when empty, returns all resources.

Default: all

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/pods

GET /api/v1/workloads/pods HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": 1,
  "pods": [
    {
      "name": "pod-of-a-very-important-job",
      "priorityClassName": "high-priority",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workloadId": "123e4567-e89b-12d3-a456-426614174000",
      "revisionId": "123e4567-e89b-12d3-a456-426614174000",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "projectId": "1",
      "nodeName": "gpu-node-1",
      "createdAt": "2022-01-01T03:49:52.531Z",
      "completedAt": "2022-01-01T03:49:52.531Z",
      "containers": [
        {
          "name": "alpine",
          "image": "alpine:latest",
          "startedAt": "2022-01-01T03:49:52.531Z"
        }
      ],
      "currentNodePool": "default",
      "requestedNodePools": [
        "default"
      ],
      "requestedResources": {
        "gpuRequestType": "portion",
        "gpu": {
          "limit": 1.5,
          "request": 1
        },
        "gpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "cpu": {
          "limit": 1.5,
          "request": 1
        },
        "cpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "allocatedResources": {
        "gpu": 1.5,
        "gpuMemory": "200Mi",
        "cpu": 0.5,
        "cpuMemory": "0B",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "tolerations": [
        {
          "key": "",
          "operator": "Exists",
          "value": "",
          "effect": "NoExecute",
          "tolerationSeconds": "10"
        }
      ],
      "k8sPhase": "Pending",
      "ip": "10.244.1.1",
      "task": "leader",
      "nodeAffinity": {
        "required": {
          "nodeSelectorTerms": [
            {
              "matchExpressions": [
                {
                  "key": "text",
                  "operator": "In",
                  "values": [
                    "text"
                  ]
                }
              ]
            }
          ]
        },
        "preferred": {
          "nodeSelectorTerms": [
            {
              "weight": 1,
              "preference": {
                "matchExpressions": [
                  {
                    "key": "text",
                    "operator": "In",
                    "values": [
                      "text"
                    ]
                  }
                ]
              }
            }
          ]
        }
      },
      "tenantId": 1001,
      "k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
      "updatedAt": "2022-06-08T11:28:24.131Z",
      "deletedAt": "2022-08-12T19:28:24.131Z",
      "projectName": "my-project",
      "workloadName": "my-workload"
    }
  ]
}

Get pod metrics data.

get

Retrieve pod's metrics data for use in analysis applications.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

workloadIdstring · uuidRequired

The Universally Unique Identifier (UUID) of the workload.

podIdstring · uuidRequired

The requested pod id.

Query parameters

startstring · date-timeRequired

Start date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-06T12:09:18.211Z

endstring · date-timeRequired

End date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-07T12:09:18.211Z

numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20

Responses

200

Executed successfully.

207

Partial success.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/{workloadId}/pods/{podId}/metrics

GET /api/v1/workloads/{workloadId}/pods/{podId}/metrics?metricType=GPU_UTILIZATION_PER_GPU&start=2023-06-06T12%3A09%3A18.211Z&end=2023-06-07T12%3A09%3A18.211Z HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "measurements": [
    {
      "type": "ALLOCATED_GPU",
      "labels": {
        "gpu": "0"
      },
      "values": [
        {
          "value": "85",
          "timestamp": "2024-12-20T14:30:00Z"
        },
        {
          "value": "92",
          "timestamp": "2024-12-20T14:30:30Z"
        },
        {
          "value": "78",
          "timestamp": "2024-12-20T14:37:00Z"
        }
      ]
    }
  ],
  "histogram": [
    {
      "type": "NIM_TIME_TO_FIRST_TOKEN_SECONDS",
      "values": [
        {
          "timestamp": "2024-12-20T14:30:00Z",
          "data": {
            "0.001": "45",
            "0.005": "178",
            "0.01": "312",
            "0.05": "624",
            "0.1": "812",
            "0.5": "980",
            "1.0": "1004",
            "2.0": "1015",
            "+Inf": "1024"
          }
        },
        {
          "timestamp": "2024-12-20T14:30:30Z",
          "data": {
            "0.001": "32",
            "0.005": "152",
            "0.01": "288",
            "0.05": "576",
            "0.1": "756",
            "0.5": "908",
            "1.0": "932",
            "2.0": "943",
            "+Inf": "960"
          }
        }
      ]
    },
    {
      "type": "NIM_TIME_TO_FIRST_TOKEN_SECONDS_PERCENTILES",
      "values": [
        {
          "timestamp": "2024-12-20T14:30:00Z",
          "data": {
            "p50": "0.0734",
            "p90": "0.1892",
            "p99": "0.2847"
          }
        },
        {
          "timestamp": "2024-12-20T14:30:30Z",
          "data": {
            "p50": "0.0823",
            "p90": "0.2134",
            "p99": "0.3156"
          }
        }
      ]
    }
  ]
}

Get workload pods by id.

get

Retrieve the details of workload pods by workload id.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

workloadIdstring · uuidRequired

The Universally Unique Identifier (UUID) of the workload.

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

searchstringOptional

Filter results by a free text search.

Example: test project

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

sortBystring · enumOptional

Sort results using a parameter.

Possible values:

filterBystring[]Optional

Example: ["nodeName!=some-node-name"]

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/{workloadId}/pods

GET /api/v1/workloads/{workloadId}/pods HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": 1,
  "pods": [
    {
      "name": "pod-of-a-very-important-job",
      "priorityClassName": "high-priority",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workloadId": "123e4567-e89b-12d3-a456-426614174000",
      "revisionId": "123e4567-e89b-12d3-a456-426614174000",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "projectId": "1",
      "nodeName": "gpu-node-1",
      "createdAt": "2022-01-01T03:49:52.531Z",
      "completedAt": "2022-01-01T03:49:52.531Z",
      "containers": [
        {
          "name": "alpine",
          "image": "alpine:latest",
          "startedAt": "2022-01-01T03:49:52.531Z"
        }
      ],
      "currentNodePool": "default",
      "requestedNodePools": [
        "default"
      ],
      "requestedResources": {
        "gpuRequestType": "portion",
        "gpu": {
          "limit": 1.5,
          "request": 1
        },
        "gpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "cpu": {
          "limit": 1.5,
          "request": 1
        },
        "cpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "allocatedResources": {
        "gpu": 1.5,
        "gpuMemory": "200Mi",
        "cpu": 0.5,
        "cpuMemory": "0B",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "tolerations": [
        {
          "key": "",
          "operator": "Exists",
          "value": "",
          "effect": "NoExecute",
          "tolerationSeconds": "10"
        }
      ],
      "k8sPhase": "Pending",
      "ip": "10.244.1.1",
      "task": "leader",
      "nodeAffinity": {
        "required": {
          "nodeSelectorTerms": [
            {
              "matchExpressions": [
                {
                  "key": "text",
                  "operator": "In",
                  "values": [
                    "text"
                  ]
                }
              ]
            }
          ]
        },
        "preferred": {
          "nodeSelectorTerms": [
            {
              "weight": 1,
              "preference": {
                "matchExpressions": [
                  {
                    "key": "text",
                    "operator": "In",
                    "values": [
                      "text"
                    ]
                  }
                ]
              }
            }
          ]
        }
      },
      "tenantId": 1001,
      "k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
      "updatedAt": "2022-06-08T11:28:24.131Z",
      "deletedAt": "2022-08-12T19:28:24.131Z",
      "projectName": "my-project",
      "workloadName": "my-workload"
    }
  ]
}

Get pods count.

get

Retrieve the number of pods from a cluster.

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

filterBystring[]Optional

Example: ["nodeName!=some-node-name"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/pods/count

GET /api/v1/workloads/pods/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get revision pods by id.

get

Retrieve the details of revision pods by revision id. Supported for clusters v2.21+.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

revisionIdstring · uuidRequired

The Universally Unique Identifier (UUID) of the revision.

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/inferences/revisions/{revisionId}/pods

GET /api/v1/workloads/inferences/revisions/{revisionId}/pods HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pods": [
    {
      "name": "pod-of-a-very-important-job",
      "priorityClassName": "high-priority",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workloadId": "123e4567-e89b-12d3-a456-426614174000",
      "revisionId": "123e4567-e89b-12d3-a456-426614174000",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "projectId": "1",
      "nodeName": "gpu-node-1",
      "createdAt": "2022-01-01T03:49:52.531Z",
      "completedAt": "2022-01-01T03:49:52.531Z",
      "containers": [
        {
          "name": "alpine",
          "image": "alpine:latest",
          "startedAt": "2022-01-01T03:49:52.531Z"
        }
      ],
      "currentNodePool": "default",
      "requestedNodePools": [
        "default"
      ],
      "requestedResources": {
        "gpuRequestType": "portion",
        "gpu": {
          "limit": 1.5,
          "request": 1
        },
        "gpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "cpu": {
          "limit": 1.5,
          "request": 1
        },
        "cpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "allocatedResources": {
        "gpu": 1.5,
        "gpuMemory": "200Mi",
        "cpu": 0.5,
        "cpuMemory": "0B",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": 2,
            "exclude": false
          }
        ]
      },
      "tolerations": [
        {
          "key": "",
          "operator": "Exists",
          "value": "",
          "effect": "NoExecute",
          "tolerationSeconds": "10"
        }
      ],
      "k8sPhase": "Pending",
      "ip": "10.244.1.1",
      "task": "leader",
      "nodeAffinity": {
        "required": {
          "nodeSelectorTerms": [
            {
              "matchExpressions": [
                {
                  "key": "text",
                  "operator": "In",
                  "values": [
                    "text"
                  ]
                }
              ]
            }
          ]
        },
        "preferred": {
          "nodeSelectorTerms": [
            {
              "weight": 1,
              "preference": {
                "matchExpressions": [
                  {
                    "key": "text",
                    "operator": "In",
                    "values": [
                      "text"
                    ]
                  }
                ]
              }
            }
          ]
        }
      },
      "tenantId": 1001,
      "k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
      "updatedAt": "2022-06-08T11:28:24.131Z",
      "deletedAt": "2022-08-12T19:28:24.131Z",
      "projectName": "my-project",
      "workloadName": "my-workload"
    }
  ]
}

PreviousEvents NextWorkloads

Last updated 3 days ago

Good night

hashtagList pods.

hashtagGet pod metrics data.

hashtagGet workload pods by id.

hashtagGet pods count.

hashtagGet revision pods by id.

List pods.

Get pod metrics data.

Get workload pods by id.

Get pods count.

Get revision pods by id.