tke · 2018-05-25

DescribeClusters

POST

Query clusters list.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tke/DescribeClusters path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://tke.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/tke/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: tke.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeClusters' \
  -H 'X-TC-Version: 2018-05-25' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
ClusterIds	string[]	—	Cluster ID list (When it is empty,
Offset	integer	—	Offset. Default value: 0
Limit	integer	—	Maximum number of output entries. Default value: 20
Filters	Filter[]	—	· "Name":"ClusterName","Values": ["test"] Filter by the [cluster name]. Type: String Required: No · "Name":"ClusterType","Values": ["MANAGED_CLUSTER"] Filter by the [cluster type]. Type: String Required: No · "Name":"ClusterStatus","Values": ["Running"] Filter by the [cluster status]. Type: String Required: No · "Name":"vpc-id","Values": ["vpc-123qajzs"] Filter by the [VPC]. Type: String Requir…
ClusterType	string	—	Cluster type, such as `MANAGED_CLUSTER`

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TotalCount	integer	Total number of clusters
Clusters	Cluster[]	Cluster information list
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "Clusters": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/tke.

SecretIdSecretKey

Request bodyvalid JSONPOST tke.api3.convergecloud.com · DescribeClusters

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TotalCount": 0,
    "Clusters": [],
    "RequestId": "44554842-0b6d-45f2-f291-f88f56c03d6c"
  }
}