tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Kubernetes Engine
    Documentation
    Download PDF

    DescribeClusters

    Last updated: 2024-11-14 14:50:42
    Download PDF

      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 Params. The value used for this API: DescribeClusters.
      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 (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 · "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 Required: No · "Name":"tag-key","Values": ["testKey"] Filter by the [tag key]. Type: String Required: No · "Name":"tag-value","Values": ["testValue"] Filter by the [tag value]. Type: String Required: No · "Name":"Tags","Values": ["abc:1"] Filter 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, 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.

      4. Example

      Example1 Querying the list of clusters

      Input Example

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

{}

      Output Example

      {
    "Response": {
        "Clusters": [
            {
                "AutoUpgradeClusterLevel": true,
                "ClusterDescription": "",
                "ClusterEtcdNodeNum": 0,
                "ClusterId": "cls-ayzfpv5c",
                "ClusterLevel": "L5",
                "ClusterMaterNodeNum": 1,
                "ClusterName": "yctest",
                "ClusterNetworkSettings": {
                    "CiliumMode": "",
                    "ClusterCIDR": "10.12.0.0/14",
                    "Cni": true,
                    "IgnoreClusterCIDRConflict": false,
                    "IgnoreServiceCIDRConflict": false,
                    "Ipv6ServiceCIDR": "",
                    "Ipvs": false,
                    "IsDualStack": false,
                    "KubeProxyMode": "",
                    "MaxClusterServiceNum": 1024,
                    "MaxNodePodNum": 64,
                    "ServiceCIDR": "10.15.252.0/22",
                    "Subnets": null,
                    "VpcId": "vpc-7modfjc3"
                },
                "ClusterNodeNum": 2,
                "ClusterOs": "tlinux3.1x86_64",
                "ClusterStatus": "Running",
                "ClusterType": "MANAGED_CLUSTER",
                "ClusterVersion": "1.24.4",
                "ContainerRuntime": "containerd",
                "CreatedTime": "2022-12-27T07:46:13Z",
                "DeletionProtection": true,
                "EnableExternalNode": false,
                "ImageId": "",
                "OsCustomizeType": "GENERAL",
                "ProjectId": 0,
                "Property": "{\"NodeNameType\":\"lan-ip\",\"NetworkType\":\"GR\"}",
                "QGPUShareEnable": false,
                "RuntimeVersion": "1.4.3",
                "TagSpecification": null
            }
        ],
        "RequestId": "583e6c4b-ff24-42f8-87f1-37e4c00d81b7",
        "TotalCount": 1
    }
}

      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
      FailedOperation.UnexpectedError Unexpected error.
      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.
      UnsupportedOperation Unsupported operation.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy