Pods

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

Deprecated

get all pods from a specific cluster. Deprecated - please use api/v1/workloads/pods instead

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

uuidstring · uuidRequired

Unique identifier of the cluster

Responses

200

Expected response to a valid request

application/json

podIdstringRequired

Identifier of the pod running the job.

jobIdstring · uuidRequired

Unique identifier of the job.

podGroupIdstringOptional

This had been used as jobId. Remained here for backward compatibility

clusterUuidstring · uuidRequired

Unique identifier of the cluster.

podNamestringRequired

The name of the pod running the job.

imageNamestringRequired

The name of the image executed by the pod.

nodeIdstringOptional

Unique identifier of the node.

phasestringRequired

statusstringOptional

createdinteger · int64Required

Creation time of the pod.

completedinteger · int64Required

Completion time of the pod.

startedinteger · int64Optional

The time when the pod started executing.

lastUpdatedinteger · int64Required

Last time the pod details were updated.

dynamicDataobjectOptional

existsInClusterbooleanOptional

nodePoolstringOptional

The node pool of the pod.

namespacestringOptional

The namespace of the pod.

401

Unauthorized

application/json

404

The specified resource was not found

application/json

default

unexpected error

application/json

get

/v1/k8s/clusters/{uuid}/pods

HTTPcURLJavaScriptPython

GET /v1/k8s/clusters/{uuid}/pods HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

List pods.

get

Retrieve a list of pods from a cluster.

Authorizations

bearerAuth

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

Responses

200

Executed successfully.

application/json

nextintegerOptionalExample: 1

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

HTTPcURLJavaScriptPython

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",
      "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",
      "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

bearerAuth

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.

application/jsontext/csv

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

HTTPcURLJavaScriptPython

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': '3'}",
      "values": [
        {
          "value": "85",
          "timestamp": "2023-06-06 12:09:18.211"
        }
      ]
    }
  ]
}

Get workload pods by id.

get

Retrieve the details of workload pods by workload id.

Authorizations

bearerAuth

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

Responses

200

Executed successfully.

application/json

nextintegerOptionalExample: 1

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

HTTPcURLJavaScriptPython

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",
      "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",
      "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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

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"]

Responses

200

Executed successfully.

application/json

countinteger · int64RequiredExample: 1

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/workloads/pods/count

HTTPcURLJavaScriptPython

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

{
  "count": 1
}