tencent cloud

Feedback

DescribeTKEEdgeClusters

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

1. API Description

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

This API is used to query the list of TKE Edge clusters.

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: DescribeTKEEdgeClusters.
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. This API only supports: ap-beijing, ap-guangzhou, ap-nanjing, ap-singapore.
ClusterIds.N No Array of String Cluster ID list (when it is empty,
all clusters under the account are 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 (only filtering by a single ClusterName is supported)

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of clusters
Clusters Array of EdgeCluster 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 cluster information

This example shows you how to query the information of all clusters under the current account.

Input Example

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

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Clusters": [
            {
                "ClusterId": "cls-xxxxxxx",
                "ClusterName": "Cluster AA",
                "K8SVersion": "1.10.5",
                "VpcId": "vpc-xxxxx",
                "PodCIDR": "172.16.0.0/20",
                "ServiceCIDR": "192.168.0.0/18",
                "Status": "running",
                "CreatedTime": "2019-08-16T04:31:26Z",
                "ClusterDesc": "test edge cluster"
            }
        ],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

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 Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
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