Jobs

job related operations

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

SecuritybearerAuth

Request

path Parameters

uuid

required

string <uuid>

Unique identifier of the cluster

query Parameters

nodeId	string Unique identifier of the node.
filter	string
sortBy	string Order of the results.
sortDirection	string Enum: "ASC" "DESC"
from	number Start the response from a given number of result. Used along with 'limit' to retrieve the results paginated.
limit	number Limit the response to a given number of results.
includeDeleted	boolean Default: true True to include deleted jobs in the result.

Responses

200

An array of Jobs

401

Unauthorized

503

unexpected error

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

Response samples

application/json

[{"JobId": "b63aeb7e-595c-4f65-82ac-857bbcab263d",
"podGroupId": "86a7c8a8-3efc-4ea3-8ae4-9941bc0624e9",
"jobName": "job-0",
"jobType": "string",
"clusterId": "string",
"status": "string",
"imageName": "tensorflow",
"user": "string",
"project": "string",
"nodeId": "string",
"creationTime": "string",
"completionTime": "string",
"totalRuntime": "string",
"totalWaitTime": "string",
"pending": 0,
"running": 0,
"parallelism": 0,
"completions": 0,
"failed": 0,
"succeeded": 0,
"currentAllocatedGPUs": 0,
"currentAllocatedGPUsMemory": 0,
"currentRequestedGPUs": 0,
"totalRequestedGPUs": 0,
"requestedGPUsPerPodGroup": 0,
"requestedGPUsMemoryPerPodGroup": 0,
"parentWorkloadName": "string",
"totalRequestedMemory": 0,
"totalRequestedCPU": 0,
"totalLimitCPU": 0,
"totalLimitMemory": 0,
"workloadKind": "runaijob",
"latestPod": {"podId": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"podGroupId": "string",
"clusterUuid": "73a3ead7-d612-44f9-b946-4e10a3d62c32",
"podName": "string",
"imageName": "string",
"nodeId": "string",
"phase": "string",
"status": "string",
"created": 0,
"completed": 0,
"started": 0,
"lastUpdated": 0,
"dynamicData": { },
"existsInCluster": true,
"resourceRequest": {"property1": 0,
"property2": 0
},
"resourceAllocation": {"property1": 0,
"property2": 0
},
"nodePool": "string",
"namespace": "string"
},
"cliCommand": "string",
"requestedMigDevices": "string",
"dynamicData": { },
"existsInCluster": true,
"isJupyter": false,
"jobUrl": "string",
"nodePool": "string"
}
]

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

SecuritybearerAuth

Request

path Parameters

uuid

required

string <uuid>

Unique identifier of the cluster

query Parameters

nodeId	string Unique identifier of the node.
filter	string

Responses

200

The job count

401

Unauthorized

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

0

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

SecuritybearerAuth

Request

path Parameters

jobId required	string <uuid> Unique identifier of the job (UUID)
uuid required	string <uuid> Unique identifier of the cluster

query Parameters

id	string id
podId	string Unique identifier of the pod.
podGroupId	string Identifier of the pod group.
nodeID	string Unique identifier of the node.
name	string The name of the job.
status	string The status of the job.

Responses

200

Expected response to a valid request

401

Unauthorized

default

unexpected error

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

Response samples

200
401
default

application/json

[{"podId": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"podGroupId": "string",
"clusterUuid": "73a3ead7-d612-44f9-b946-4e10a3d62c32",
"podName": "string",
"imageName": "string",
"nodeId": "string",
"phase": "string",
"status": "string",
"created": 0,
"completed": 0,
"started": 0,
"lastUpdated": 0,
"dynamicData": { },
"existsInCluster": true,
"resourceRequest": {"property1": 0,
"property2": 0
},
"resourceAllocation": {"property1": 0,
"property2": 0
},
"nodePool": "string",
"namespace": "string"
}
]

➔ Next to Pods