Get cluster workloads list

PreviousGet cluster configuration list NextGet cluster pods list

Was this helpful?

Get cluster workloads list

Get the workload list for that cluster.

GET/v1/clusters/{clusterId}/workloads

Path parameters

clusterId*string

Response

Body

activeCountinteger

Example: 1

computeTotalinteger

Total number of computes

Example: 1

creationTimestampstring

Example: "2023-04-29 05:54:54"

descriptionstring

Example: ""

isK8sResourceExistboolean

namespaceNamestring

Example: "cocktail-system"

qosstring

QoS

Example: "Burstable"

stateCodestring

stateCode(RUNNING, STOPPED)

Example: "RUNNING"

workloadGroupSeqinteger

Example: 11

workloadNamestring

Example: "cocktail-api-cmdb"

workloadTypestring

Example: "STATEFUL_SET_SERVER"

Request

const response = await fetch('/v1/clusters/{clusterId}/workloads', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "activeCount": 1,
    "computeTotal": 1,
    "creationTimestamp": "2023-04-29 05:54:54",
    "description": "",
    "isK8sResourceExist": false,
    "namespaceName": "cocktail-system",
    "qos": "Burstable",
    "stateCode": "RUNNING",
    "workloadGroupSeq": 11,
    "workloadName": "cocktail-api-cmdb",
    "workloadType": "STATEFUL_SET_SERVER"
  }
]