Help & DocumentationAPIsTencent Kubernetes EngineCluster-related APIsDescribeClusters

DescribeClusters

Last updated: 2020-04-03 12:01:28

1. API Description

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

This API is used to query clusters list.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeClusters.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterIds.N No Array of String Cluster ID list (When it is empty,
all clusters under the account will be obtained)
Offset No Integer Offset. Default value: 0
Limit No Integer Maximum number of output entries. Default value: 20
Filters.N No Array of Filter Filter condition. Currently, only filtering by a single ClusterName is supported

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of clusters
Clusters Array of Cluster Cluster information list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the Cluster List

Query the cluster list to obtain the cluster list

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeClusters
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "Clusters": [
      {
        "ClusterId": "cls-xxxxxxx",
        "ClusterName": "Cluster",
        "ClusterDescription": "",
        "ClusterVersion": "1.10.5",
        "ClusterOs": "ubuntu16.04.1 LTSx86_64",
        "ClusterType": "INDEPENDENT_CLUSTER",
        "ClusterNetworkSettings": {
          "ClusterCIDR": "10.211.0.0/16",
          "IgnoreClusterCIDRConflict": false,
          "MaxNodePodNum": 256,
          "MaxClusterServiceNum": 256,
          "Ipvs": false,
          "VpcId": "vpc-xxxxxx"
        },
        "ClusterNodeNum": 3
      }
    ],
    "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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
InternalError Internal error
InternalError.CamNoAuth You do not have permissions.
InternalError.Db DB error.
InternalError.DbAffectivedRows DB error
InternalError.Param Parameter error.
InternalError.PublicClusterOpNotSupport Cluster does not support the current operation.
InternalError.QuotaMaxClsLimit Quota limit exceeded.
InternalError.QuotaMaxNodLimit Quota limit exceeded.
InvalidParameter Parameter error
InvalidParameter.Param Invalid parameter.
LimitExceeded Quota limit exceeded
ResourceNotFound Resource does not exist