Get revision data. | NVIDIA Run:ai Documentation

{
  "type": "runai-revision",
  "name": "very-important-job",
  "id": "string",
  "workloadId": "string",
  "tenantId": 1001,
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "projectId": "1",
  "departmentId": "2",
  "createdAt": "2022-01-01T03:49:52.531Z",
  "phase": "Creating",
  "deletedAt": "2022-08-12T19:28:24.131Z",
  "revisionRequestedResources": {
    "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
      }
    ]
  },
  "podsRequestedResources": {
    "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
      }
    ]
  },
  "requestedPods": {
    "number": 1,
    "min": 2,
    "max": 5,
    "parallelism": 3,
    "completions": 5
  },
  "requestedNodePools": [
    "default"
  ],
  "allocatedResources": {
    "gpu": 1.5,
    "gpuMemory": "200Mi",
    "cpu": 0.5,
    "cpuMemory": "0B",
    "extendedResources": [
      {
        "resource": "hardware-vendor.example/foo",
        "quantity": "2",
        "exclude": false
      }
    ]
  },
  "currentNodePools": [
    "default"
  ],
  "runningPods": 1,
  "images": [
    "alpine:latest"
  ],
  "environmentVariables": {},
  "command": "sleep",
  "arguments": "1000",
  "conditions": [
    {
      "type": "Ready",
      "status": "False",
      "message": "Resource validation failed: ...",
      "reason": "ErrorConfig",
      "lastTransitionTime": "2022-01-01T03:49:52.531Z"
    }
  ],
  "phaseMessage": "Not enough resources in the requested nodepool",
  "phaseUpdatedAt": "2022-06-08T11:28:24.131Z",
  "additionalFields": {}
}

Retrieve revision details using a revision id. Supported for clusters v2.21+.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

revisionIdstringRequiredformat: "uuid"

The Universally Unique Identifier (UUID) of the revision.

Response

Executed successfully.

typestring

namestring

idstringformat: "uuid"

workloadIdstringformat: "uuid"

tenantIdinteger

The id of the tenant.

clusterIdstringformat: "uuid"

The id of the cluster.

projectIdstringformat: ".*"

The id of the project.

departmentIdstringformat: ".*">=1 character

The id of the department.

createdAtdatetime

phaseenum

deletedAtdatetime or nullOptional

revisionRequestedResourcesobjectOptional

podsRequestedResourcesobjectOptional

requestedPodsobjectOptional

requestedNodePoolslist of stringsOptional

allocatedResourcesobjectOptional

currentNodePoolslist of stringsOptional

runningPodsintegerOptional

imageslist of stringsOptional

environmentVariablesmap from strings to stringsOptional

commandstringOptional

argumentsstringOptional

conditionslist of objectsOptional

phaseMessagestringOptional

phaseUpdatedAtdatetimeOptional

additionalFieldsmap from strings to anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error