DeleteClusterInstances

Last updated: 2019-09-09 11:35:56

PDF

1. API Description

API domain name: tke.tencentcloudapi.com.

This API deletes one or more instances from the specified cluster.

API request rate limit: 20 requests/sec.

Note: This API supports financial regions. As financial regions and non-financial regions are isolated, if a financial region,such as ap-shanghai-fsi, is assigned to the common parameter Region, we recommend you include that financial region in your domain name , such as tke.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The name of this API: DeleteClusterInstances
Version Yes String Common parameter. The version of this API: 2018-05-25
Region Yes String Common parameter. For more information, 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 for deleting instances in the cluster: terminate: terminate the instance. It’s is available only for pay-as-you-go CVM instances; retain: only remove it from the cluster. The instance will be retained.

3. Output Parameters

Parameter Name Type Description
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Deleting an Instance from a Cluster

Delete an instance from a cluster

Input Sample Code

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

Output Sample Code

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

5. Resources for Developers

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 software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

Command line tools

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.Db Database error.
InternalError.DbAffectivedRows Database effective function error.
InternalError.Param Param.
InternalError.PublicClusterOpNotSupport The cluster does not support the current operation.
InvalidParameter Invalid parameter.
LimitExceeded Quota limit is exceeded.