DescribeClusters

Last updated: 2021-10-20 16:47:44

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.

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 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 · ClusterName
Filters by the cluster name
Type: String
Required: no

· Tags
Filters by key-value pairs of tags
Type: String
Required: no

· vpc-id
Filters by the VPC ID
Type: String
Required: no

· tag-key
Filters by the tag key
Type: String
Required: no

· tag-value
Filters by the tag value
Type: String
Required: no

· tag:tag-key
Filters by key-value pairs of tags
Type: String
Required: no
ClusterType No String Cluster type, such as MANAGED_CLUSTER

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

Input Example

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<Common request parameters>

{}

Output Example

{
  "Response": {
    "TotalCount": 1,
    "RequestId": "xx",
    "Clusters": [
      {
        "DeletionProtection": true,
        "ClusterVersion": "xx",
        "TagSpecification": [
          {
            "ResourceType": "xx",
            "Tags": [
              {
                "Value": "xx",
                "Key": "xx"
              }
            ]
          }
        ],
        "ClusterName": "xx",
        "ClusterId": "xx",
        "ClusterNodeNum": 1,
        "ClusterType": "xx",
        "ClusterDescription": "xx",
        "ImageId": "xx",
        "CreatedTime": "xx",
        "EnableExternalNode": true,
        "ContainerRuntime": "xx",
        "ClusterMaterNodeNum": 1,
        "ProjectId": 1,
        "OsCustomizeType": "xx",
        "ClusterNetworkSettings": {
          "Subnets": [
            "xx"
          ],
          "VpcId": "xx",
          "ServiceCIDR": "xx",
          "MaxClusterServiceNum": 1,
          "KubeProxyMode": "xx",
          "MaxNodePodNum": 1,
          "Ipvs": true,
          "ClusterCIDR": "xx",
          "IgnoreClusterCIDRConflict": true,
          "Cni": true
        },
        "Property": "xx",
        "ClusterOs": "xx",
        "ClusterStatus": "xx"
      }
    ]
  }
}

5. Developer Resources

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 Database error.
InternalError.Param Parameter error.
InternalError.PublicClusterOpNotSupport Cluster does not support the current operation.
InternalError.QuotaMaxClsLimit Quota limit exceeded.
InternalError.QuotaMaxNodLimit Quota limit exceeded.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
LimitExceeded Quota limit is exceeded.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.