Domain name for API request: tke.tencentcloudapi.com.
This API is used to delete a cluster. (Cloud API v3).
A maximum of 50 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
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: DeleteCluster. |
| 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 |
| InstanceDeleteMode | Yes | String | Policy used to delete an instance in the cluster: terminate (terminates the instance. Only available for instances on pay-as-you-go CVMs); retain (only removes it from the cluster. The instance will be retained.) |
| ResourceDeleteOptions.N | No | Array of ResourceDeleteOption | Specifies the policy to deal with resources in the cluster when the cluster is deleted. It only supports CBS now. The default policy is to retain CBS disks. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to delete a cluster.
https://tke.tencentcloudapi.com/?Action=DeleteCluster
&ClusterId=cls-xxxxxxxx
&InstanceDeleteMode=terminate
&<Common request parameters>{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.ClusterNotFound | Cluster not found. |
| InternalError.ClusterState | Cluster status error. |
| InternalError.Param | Parameter error. |
| InternalError.PublicClusterOpNotSupport | Cluster does not support the current operation. |
| InvalidParameter | Parameter error. |
| OperationDenied.ClusterInDeletionProtection | The cluster is under deletion protection and cannot be deleted. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resource is unavailable |
Was this page helpful?