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

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

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

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: */*

[]