tencent cloud

文档反馈

DeleteClusterInstances

最后更新时间:2022-07-26 11:09:19

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.

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: DeleteClusterInstances.
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 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)

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

This example shows you how to 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": {
    "SuccInstanceIds": [
      "xxx"
    ],
    "FailedInstanceIds": [
      "xxx"
    ],
    "NotFoundInstanceIds": [
      "xxx"
    ],
    "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.AsCommon An error occurs while creating scaling group resources.
FailedOperation.ClusterNotFound The cluster is not found.
FailedOperation.ClusterState Cluster status error.
FailedOperation.Param Invalid parameter.
InternalError Internal error.
InternalError.AsCommon Error creating scaling group resource.
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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持