Jobs

job related operations

Deprecated

List all Jobs in the cluster. Deprecated - please use api/v1/workloads instead

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

uuidstring · uuidRequired

Unique identifier of the cluster

Query parameters

nodeIdstringOptional

Unique identifier of the node.

filterstringOptional

sortBystringOptional

Order of the results.

sortDirectionstring · enumOptionalPossible values:

fromnumberOptional

Start the response from a given number of result. Used along with 'limit' to retrieve the results paginated.

limitnumberOptional

Limit the response to a given number of results.

includeDeletedbooleanOptional

True to include deleted jobs in the result.

Default: true

Responses

200

An array of Jobs

application/json

JobIdstring · uuidOptional

Unique identifier of the job.

podGroupIdstring · uuidOptional

Unique identifier of the pod group.

jobNamestringOptional

The name of the job.

Example: job-0

jobTypestringOptional

clusterIdstringOptional

Unique identifier of the cluster.

statusstringOptional

imageNamestringOptional

The name of the image executed by the pod.

Example: tensorflow

userstringOptional

The owner of the job.

projectstringOptional

The project that the pod group belongs to.

nodeIdstringOptional

Unique identifier of the node.

creationTimestringOptional

Creation time of the job.

completionTimestringOptional

Completion time of the job.

totalRuntimestringOptional

totalWaitTimestringOptional

pendingnumberOptional

runningnumberOptional

parallelismnumberOptional

completionsnumberOptional

failednumberOptional

succeedednumberOptional

currentAllocatedGPUsnumberOptional

currentAllocatedGPUsMemorynumberOptional

currentRequestedGPUsnumberOptional

totalRequestedGPUsnumberOptional

requestedGPUsPerPodGroupnumberOptional

requestedGPUsMemoryPerPodGroupnumberOptional

parentWorkloadNamestringOptional

totalRequestedMemorynumberOptional

totalRequestedCPUnumberOptional

totalLimitCPUnumberOptional

totalLimitMemorynumberOptional

workloadKindnumberOptional

Specifies the kind of k8s resource that owns the pod group.

Example: runaijob

cliCommandstringOptional

requestedMigDevicesstringOptionalDeprecated

dynamicDataobjectOptional

existsInClusterbooleanOptional

isJupyterbooleanOptional

If true, it indicates that the pod group runs jupyter notebook.

Default: false

jobUrlstringOptional

nodePoolstringOptional

The node pool of the job.

401

Unauthorized

application/json

503

unexpected error

application/json

get

/v1/k8s/clusters/{uuid}/jobs

HTTPcURLJavaScriptPython

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

[
  {
    "JobId": "123e4567-e89b-12d3-a456-426614174000",
    "podGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "jobName": "job-0",
    "jobType": "text",
    "clusterId": "text",
    "status": "text",
    "imageName": "tensorflow",
    "user": "text",
    "project": "text",
    "nodeId": "text",
    "creationTime": "text",
    "completionTime": "text",
    "totalRuntime": "text",
    "totalWaitTime": "text",
    "pending": 1,
    "running": 1,
    "parallelism": 1,
    "completions": 1,
    "failed": 1,
    "succeeded": 1,
    "currentAllocatedGPUs": 1,
    "currentAllocatedGPUsMemory": 1,
    "currentRequestedGPUs": 1,
    "totalRequestedGPUs": 1,
    "requestedGPUsPerPodGroup": 1,
    "requestedGPUsMemoryPerPodGroup": 1,
    "parentWorkloadName": "text",
    "totalRequestedMemory": 1,
    "totalRequestedCPU": 1,
    "totalLimitCPU": 1,
    "totalLimitMemory": 1,
    "workloadKind": "runaijob",
    "latestPod": {
      "podId": "text",
      "jobId": "123e4567-e89b-12d3-a456-426614174000",
      "podGroupId": "text",
      "clusterUuid": "123e4567-e89b-12d3-a456-426614174000",
      "podName": "text",
      "imageName": "text",
      "nodeId": "text",
      "phase": "text",
      "status": "text",
      "created": 1,
      "completed": 1,
      "started": 1,
      "lastUpdated": 1,
      "dynamicData": {},
      "existsInCluster": true,
      "resourceRequest": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "resourceAllocation": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "nodePool": "text",
      "namespace": "text"
    },
    "cliCommand": "text",
    "dynamicData": {},
    "existsInCluster": true,
    "isJupyter": false,
    "jobUrl": "text",
    "nodePool": "text"
  }
]

Deprecated

Return the number all Jobs in the cluster. Deprecated - please use api/v1/workloads/count instead

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

uuidstring · uuidRequired

Unique identifier of the cluster

Query parameters

nodeIdstringOptional

Unique identifier of the node.

filterstringOptional

Responses

200

The job count

application/json

numberOptional

401

Unauthorized

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/v1/k8s/clusters/{uuid}/jobs/count

HTTPcURLJavaScriptPython

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

1

Deprecated

Get all pods that are associated for a specific job. Deprecated - please use api/v1/workloads/{workloadId}/pods instead

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

jobIdstring · uuidRequired

Unique identifier of the job (UUID)

uuidstring · uuidRequired

Unique identifier of the cluster

Query parameters

idstringOptional

id

podIdstringOptional

Unique identifier of the pod.

podGroupIdstringOptional

Identifier of the pod group.

nodeIDstringOptional

Unique identifier of the node.

namestringOptional

The name of the job.

statusstringOptional

The status of the job.

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

default

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

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

[]