DescribeClusterAsGroups

Last updated: 2020-08-20 18:04:47

1. API Description

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

Cluster-associated scaling group 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

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: DescribeClusterAsGroups.
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.
ClusterId Yes String Cluster ID
AutoScalingGroupIds.N No Array of String Scaling group ID list. If this value is null, it indicates that all cluster-associated scaling groups are pulled.
Offset No Integer Offset. This value defaults to 0. For more information on Offset, see the relevant sections in API Overview.
Limit No Integer Number of returned results. This value defaults to 20. The maximum is 100. For more information on Limit, see the relevant sections in API Overview.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of scaling groups associated with the cluster
ClusterAsGroupSet Array of ClusterAsGroup Cluster-associated scaling group list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Cluster-associated scaling group list

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeClusterAsGroups
&ClusterId=cls-xxxxxx
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "82f2fe9c-c5fa-4077-9236-f1341180a696"
  }
}

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
FailedOperation Operation failed
InternalError Internal error
InternalError.AccountUserNotAuthenticated Account not verified.
InternalError.AsCommon Error creating scaling group resource.
InternalError.ClusterNotFound Cluster not found.
InternalError.ClusterState Cluster status error.
InternalError.Db DB error.
InternalError.Param Parameter error.
InternalError.PodNotFound Pod not found
InternalError.VpcCommon VPC error
InternalError.VpcPeerNotFound Peering connection does not exist
InternalError.VpcRecodrNotFound VPC record not found

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help