Documentation|Tencent Cloud

Recent Pages

DeleteClusterInstances

Last updated: 2020-07-31 14:38:55

1. API Description

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

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: 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

3. Output Parameters

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.

4. Example

Example1 Deleting a Node in a Cluster

Delete a node in a cluster

Input Example

https://tke.tencentcloudapi.com/?Action=DeleteClusterInstances
&ClusterId=cls-xxxxxx
&InstanceIds.0=ins-xxxxx
&InstanceDeleteMode=terminate
&<Common request parameters>

Output Example

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

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.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
InternalError	Internal error
InternalError.Db	DB error.
InternalError.DbAffectivedRows	DB error
InternalError.Param	Parameter error.
InternalError.PublicClusterOpNotSupport	Cluster does not support the current operation.
InternalError.UnexceptedInternal	Internal error
InvalidParameter	Parameter error
LimitExceeded	Quota limit exceeded