tencent cloud



Last updated: 2022-08-23 11:20:52

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

This API is used to query the information of clusters under the current account.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeClusterStatus.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterIds.N No Array of String Cluster ID list. All clusters are pulled if it is left empty.

3. Output Parameters

Parameter Name Type Description
ClusterStatusSet Array of ClusterStatus Cluster status list
TotalCount Integer Number of clusters
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the current cluster status

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TotalCount": 1,
        "ClusterStatusSet": [
                "ClusterClosingNodeNum": 0,
                "ClusterAuditEnabled": true,
                "ClusterDeletionProtection": true,
                "ClusterId": "xx",
                "ClusterBMonitor": true,
                "ClusterInitNodeNum": 0,
                "ClusterState": "xx",
                "ClusterClosedNodeNum": 0,
                "ClusterInstanceState": "xx",
                "ClusterRunningNodeNum": 0,
                "ClusterFailedNodeNum": 0
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.CamNoAuth Not authorized to access this API
FailedOperation.ComponentClientHttp Internal HTTP client error.
FailedOperation.ComponentClientUnpack Internal HTTP decapsulation failed.
FailedOperation.ComponentClinetHttp Failed to request (HTTP request) other Tencent Cloud services.
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InternalError.ComponentClinetHttp Error while requesting (HTTP) other Tencent Cloud services
InternalError.CvmCommon Error in node creation.
InternalError.CvmNotFound CVM does not exist.
InternalError.Db DB error.
InternalError.Param Parameter error.
InternalError.UnexceptedInternal Internal error.
InvalidParameter Parameter error.
MissingParameter Missing parameter.
UnknownParameter Unknown parameter.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support