Pods

Retrieve data about workload pods from your Run:ai platform.

get all pods from a specific cluster. Deprecated - please use api/v1/workloads/pods insteadDeprecated

SecuritybearerAuth

Request

path Parameters

uuid

required

string <uuid>

Unique identifier of the cluster

Responses

200

Expected response to a valid request

401

Unauthorized

404

The specified resource was not found

default

unexpected error

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

Response samples

200
401
404
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"
}
]

List pods.

Retrieve a list of pods from a cluster.

SecuritybearerAuth

Request

query Parameters

deleted	boolean Return only deleted resources when `true`.
offset	integer <int32> The offset of the first item returned in the collection. Example: offset=100
limit	integer <int32> [ 1 .. 500 ] Default: 50 The maximum number of entries to return.
sortOrder	string Default: "asc" Sort results in descending or ascending order. Enum: "asc" "desc"
sortBy	string Sort results using a parameter. Enum: "clusterId" "workloadId" "revisionId" "nodeName" "currentNodepool" "createdAt" "completedAt" "deletedAt"
filterBy	Array of strings 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 `>=`. Example: filterBy=nodeName!=some-node-name
verbosity	string (PodVerbosity) Default: "brief" response verbosity level. if full, the response includes workloadName and projectName fields. Enum: "brief" "full" Example: verbosity=full
completed	string Default: "all" Return only completed resources when 'true', return only non-completed resources when 'false'. By default, or when empty, returns all resources.
search	string Filter results by a free text search. Example: search=test project

Responses

200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/pods

Response samples

application/json

{"next": 1,
"pods": [{"name": "pod-of-a-very-important-job",
"priorityClassName": "high-priority",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workloadId": "06d16c5d-4728-42fa-b573-3b11820d999f",
"revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"projectId": "1",
"nodeName": "gpu-node-1",
"createdAt": "2022-01-01T03:49:52.531Z",
"completedAt": "2022-01-01T03:49:52.531Z",
"containers": [{"name": "alpine",
"image": "alpine:latest",
"startedAt": "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"
},
"migProfile": "1g.5gb",
"extendedResources": [{"resource": "hardware-vendor.example/foo",
"quantity": 2,
"exclude": false
}
]
},
"allocatedResources": {"gpu": 1.5,
"migProfile": "1g.5gb",
"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"
}
],
"k8sPhase": "Pending",
"ip": "10.244.1.1",
"tenantId": 1001,
"k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
"updatedAt": "2022-06-08T11:28:24.131Z",
"deletedAt": "2022-08-12T19:28:24.131Z",
"projectName": "my-project",
"workloadName": "my-workload"
}
]
}

Get pod metrics data.

Retrieve pod's metrics data for use in analysis applications.

SecuritybearerAuth

Request

path Parameters

workloadId required	string <uuid> The Universally Unique Identifier (UUID) of the workload.
podId required	string <uuid> The requested pod id.

query Parameters

metricType required	Array of strings (PodMetricType) Specify which metric data to request. Advanced GPU metrics are only supported if the 'Advanced GPU Metrics' feature flag in the settings is enabled. Items Enum: "GPU_UTILIZATION_PER_GPU" "GPU_UTILIZATION" "GPU_MEMORY_USAGE_BYTES_PER_GPU" "GPU_MEMORY_USAGE_BYTES" "CPU_USAGE_CORES" "CPU_MEMORY_USAGE_BYTES" "GPU_GRAPHICS_ENGINE_ACTIVITY_PER_GPU" "GPU_SM_ACTIVITY_PER_GPU" "GPU_SM_OCCUPANCY_PER_GPU" "GPU_TENSOR_ACTIVITY_PER_GPU" "GPU_FP64_ENGINE_ACTIVITY_PER_GPU" "GPU_FP32_ENGINE_ACTIVITY_PER_GPU" "GPU_FP16_ENGINE_ACTIVITY_PER_GPU" "GPU_MEMORY_BANDWIDTH_UTILIZATION_PER_GPU" "GPU_NVLINK_TRANSMITTED_BANDWIDTH_PER_GPU" "GPU_NVLINK_RECEIVED_BANDWIDTH_PER_GPU" "GPU_PCIE_TRANSMITTED_BANDWIDTH_PER_GPU" "GPU_PCIE_RECEIVED_BANDWIDTH_PER_GPU" "GPU_SWAP_MEMORY_BYTES_PER_GPU"
start required	string <date-time> Start date of time range to fetch data in ISO 8601 timestamp format. Example: start=2023-06-06T12:09:18.211Z
end required	string <date-time> End date of time range to fetch data in ISO 8601 timestamp format. Example: end=2023-06-07T12:09:18.211Z
numberOfSamples	integer [ 0 .. 1000 ] Default: 20 The number of samples to take in the specified time range. Example: numberOfSamples=20

Responses

200

Executed successfully.

207

Partial success.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/{workloadId}/pods/{podId}/metrics

Response samples

{"measurements": [{"type": "ALLOCATED_GPU",
"labels": "{'gpu': '3'}",
"values": [{"value": "85",
"timestamp": "2023-06-06 12:09:18.211"
}
]
}
]
}

Get workload pods by id.

Retrieve the details of workload pods by workload id.

SecuritybearerAuth

Request

path Parameters

workloadId

required

string <uuid>

The Universally Unique Identifier (UUID) of the workload.

query Parameters

deleted	boolean Return only deleted resources when `true`.
offset	integer <int32> The offset of the first item returned in the collection. Example: offset=100
limit	integer <int32> [ 1 .. 500 ] Default: 50 The maximum number of entries to return.
search	string Filter results by a free text search. Example: search=test project

Responses

200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/{workloadId}/pods

Response samples

application/json

{"next": 1,
"pods": [{"name": "pod-of-a-very-important-job",
"priorityClassName": "high-priority",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workloadId": "06d16c5d-4728-42fa-b573-3b11820d999f",
"revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"projectId": "1",
"nodeName": "gpu-node-1",
"createdAt": "2022-01-01T03:49:52.531Z",
"completedAt": "2022-01-01T03:49:52.531Z",
"containers": [{"name": "alpine",
"image": "alpine:latest",
"startedAt": "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"
},
"migProfile": "1g.5gb",
"extendedResources": [{"resource": "hardware-vendor.example/foo",
"quantity": 2,
"exclude": false
}
]
},
"allocatedResources": {"gpu": 1.5,
"migProfile": "1g.5gb",
"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"
}
],
"k8sPhase": "Pending",
"ip": "10.244.1.1",
"tenantId": 1001,
"k8sPhaseUpdatedAt": "2022-06-08T11:28:24.131Z",
"updatedAt": "2022-06-08T11:28:24.131Z",
"deletedAt": "2022-08-12T19:28:24.131Z",
"projectName": "my-project",
"workloadName": "my-workload"
}
]
}

Get pods count.

Retrieve the number of pods from a cluster.

SecuritybearerAuth

Request

query Parameters

deleted	boolean Return only deleted resources when `true`.
filterBy	Array of strings 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 `>=`. Example: filterBy=nodeName!=some-node-name
search	string Filter results by a free text search. Example: search=test project

Responses

200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/pods/count

Response samples

application/json

{"count": 1
}

➔ Next to Workloads