tencent cloud

All product documents
Tencent Kubernetes Engine
DeleteClusterAsGroups
Last updated: 2024-11-14 14:49:46
DeleteClusterAsGroups
Last updated: 2024-11-14 14:49:46

1. API Description

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

Delete a cluster scaling group

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: DeleteClusterAsGroups.
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.
ClusterId Yes String The cluster ID, obtained through the DescribeClusters API.
AutoScalingGroupIds.N Yes Array of String Cluster scaling group ID list
KeepInstance No Boolean Whether to keep nodes in the scaling group. Default to false (not keep)

3. Output Parameters

Parameter Name Type Description
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 Deleting a cluster scaling group

This example shows you how to delete a cluster scaling group.

Input Example

https://tke.tencentcloudapi.com/?Action=DeleteClusterAsGroups
&ClusterId=cls-xxxxxx
&AutoScalingGroupIds.0=asg-xxxxxxxx
&KeepInstance=false
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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.
FailedOperation.ClusterNotFound The cluster is not found.
FailedOperation.ClusterState Cluster status error.
FailedOperation.Param Invalid parameter.
InternalError Internal error.
InternalError.AccountUserNotAuthenticated Account not verified.
InternalError.AsCommon Error creating scaling group resource.
InternalError.ClusterNotFound Cluster not found.
InternalError.Param Parameter error.
InternalError.PublicClusterOpNotSupport Cluster does not support the current operation.
InternalError.QuotaMaxClsLimit Quota limit exceeded.
InternalError.QuotaMaxNodLimit Quota limit exceeded.
InternalError.QuotaMaxRtLimit Quota limit exceeded.
InvalidParameter Parameter error.
InvalidParameter.AsCommonError Auto scaling group creation parameter error.
InvalidParameter.Param Invalid parameter.
LimitExceeded Quota limit is exceeded.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
UnknownParameter Unknown parameter.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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