Query status and config of Cluster Instances.

curl --request GET \
  --url https://{apiHost}/api/v1/cluster/instances/status-config \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/cluster/instances/status-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "title": "<string>",
      "projectId": "<string>",
      "tags": {},
      "clusterPolicyId": "<string>",
      "adminState": "ADMIN_STATE_UNSPECIFIED",
      "runState": "CLUSTER_RUN_STATE_UNSPECIFIED",
      "edgeNodePoolIDs": [
        "<string>"
      ],
      "serverNodeIDs": [
        "<string>"
      ],
      "agentNodeIDs": [
        "<string>"
      ],
      "nodesJobName": "<string>",
      "orchestratorClusterID": "<string>",
      "orchestratorClusterRunState": "RUN_STATE_UNSPECIFIED",
      "orchestratorClusterErrMsg": {
        "description": "<string>",
        "severity": "<string>",
        "objectName": "<string>"
      },
      "orchestratorClusterWarnMsg": {
        "description": "<string>",
        "severity": "<string>",
        "objectName": "<string>"
      },
      "projectName": "<string>",
      "clusterType": "CLUSTER_TYPE_UNSPECIFIED"
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Query Parameters

summary

boolean

cluster instance summary flag

namePattern

string

name pattern

project

string

User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed

projectNamePattern

string

project name pattern

next.pageToken

string

Page Token

next.orderBy

string[]

OrderBy helps in sorting the list response

next.pageNum

number<int64>

Page Number

next.pageSize

number<int64>

Defines the page size

next.totalPages

number<int64>

Total number of pages to be fetched.

fields

string[]

Fields to select: id, name, title, projectId, tags, clusterPolicyId, adminState, runState, edgeNodePoolIDs, serverNodeIDs, agentNodeIDs, nodesJobName, orchestratorClusterID, orchestratorClusterRunState, orchestratorClusterErrMsg, orchestratorClusterWarnMsg, projectName, clusterType

Response

A successful response.

ClusterInstStatusListMsg is used for listing the cluster instance statuses

list

Cluster instance status summary · object[]

cluster instance status summary

Show child attributes

summaryByState

Summary is used to store the Summary details · object

cluster instance status by state

Show child attributes

Cursor is used as filter in list operation. · object

cursor next

Show child attributes

⌘I

Query status and config of Cluster Instances.

curl --request GET \
  --url https://{apiHost}/api/v1/cluster/instances/status-config \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/cluster/instances/status-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "title": "<string>",
      "projectId": "<string>",
      "tags": {},
      "clusterPolicyId": "<string>",
      "adminState": "ADMIN_STATE_UNSPECIFIED",
      "runState": "CLUSTER_RUN_STATE_UNSPECIFIED",
      "edgeNodePoolIDs": [
        "<string>"
      ],
      "serverNodeIDs": [
        "<string>"
      ],
      "agentNodeIDs": [
        "<string>"
      ],
      "nodesJobName": "<string>",
      "orchestratorClusterID": "<string>",
      "orchestratorClusterRunState": "RUN_STATE_UNSPECIFIED",
      "orchestratorClusterErrMsg": {
        "description": "<string>",
        "severity": "<string>",
        "objectName": "<string>"
      },
      "orchestratorClusterWarnMsg": {
        "description": "<string>",
        "severity": "<string>",
        "objectName": "<string>"
      },
      "projectName": "<string>",
      "clusterType": "CLUSTER_TYPE_UNSPECIFIED"
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Query status and config of Cluster Instances.

Authorizations

Headers

Query Parameters

Response