List pods. | NVIDIA Run:ai Documentation

{
  "pods": [
    {
      "name": "pod-of-a-very-important-job",
      "priorityClassName": "high-priority",
      "id": "string",
      "workloadId": "string",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "createdAt": "2022-01-01T03:49:52.531Z",
      "containers": [
        {
          "name": "alpine",
          "image": "alpine:latest",
          "startedAt": "2022-01-01T03:49:52.531Z"
        }
      ],
      "k8sPhase": "Pending",
      "tenantId": 1001,
      "k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
      "updatedAt": "2022-06-08T11:28:24.131Z",
      "revisionId": "string",
      "projectId": "1",
      "nodeName": "gpu-node-1",
      "completedAt": "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
        }
      ],
      "ip": "10.244.1.1",
      "task": "leader",
      "nodeAffinity": {
        "required": {
          "nodeSelectorTerms": [
            {
              "matchExpressions": [
                {
                  "key": "string",
                  "operator": "In",
                  "values": [
                    "string"
                  ]
                }
              ]
            }
          ]
        },
        "preferred": {
          "nodeSelectorTerms": [
            {
              "weight": 1.1,
              "preference": {
                "matchExpressions": [
                  {
                    "key": "string",
                    "operator": "In",
                    "values": [
                      "string"
                    ]
                  }
                ]
              }
            }
          ]
        }
      },
      "elements": [
        {
          "elementId": "string",
          "hierarchyLevel": 1
        }
      ],
      "deletedAt": "2022-08-12T19:28:24.131Z",
      "projectName": "my-project",
      "workloadName": "my-workload"
    }
  ],
  "next": 1
}

Retrieve a list of pods from a cluster.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

deletedbooleanOptional

Return only deleted resources when true.

offsetintegerOptional

The offset of the first item returned in the collection.

limitintegerOptional1-500Defaults to 50

The maximum number of entries to return.

sortOrderenumOptionalDefaults to asc

Sort results in descending or ascending order.

Allowed values:

sortByenumOptional

Sort results using a parameter.

filterBylist of stringsOptional

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 >=.

verbosityenumOptionalDefaults to brief

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

Allowed values:

completedstringOptionalDefaults to all

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

searchstringOptional

Filter results by a free text search.

Response

Executed successfully.

podslist of objects

nextintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error