Domain name for API request: tke.tencentcloudapi.com.
This API is used to delete one or more nodes from a cluster.
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
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: DeleteClusterInstances. |
| 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 |
| InstanceIds.N | Yes | Array of String | List of Instance IDs |
| InstanceDeleteMode | No | String | Policy used to delete an instance in the cluster: terminate (terminates the instance. Only available for pay-as-you-go CVMs); retain (only removes it from the cluster. The instance will be retained.) |
| ForceDelete | No | Boolean | Whether or not there is forced deletion (when a node is initialized, the parameters can be specified as TRUE) |
| Parameter Name | Type | Description |
|---|---|---|
| SuccInstanceIds | Array of String | IDs of deleted instances |
| FailedInstanceIds | Array of String | IDs of instances failed to be deleted |
| NotFoundInstanceIds | Array of String | IDs of instances that cannot be found |
| 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 node in a cluster.
https://tke.tencentcloudapi.com/?Action=DeleteClusterInstances
&ClusterId=cls-xxxxxx
&InstanceIds.0=ins-xxxxx
&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 |
|---|---|
| InternalError | Internal error. |
| InternalError.ClusterNotFound | Cluster not found. |
| InternalError.ClusterState | Cluster status error. |
| InternalError.Db | DB error. |
| InternalError.DbAffectivedRows | Database error. |
| InternalError.Param | Parameter error. |
| InternalError.PublicClusterOpNotSupport | Cluster does not support the current operation. |
| InternalError.UnexceptedInternal | Internal error. |
| InvalidParameter | Parameter error. |
| LimitExceeded | Quota limit is exceeded. |
Was this page helpful?