TerminateClusterNodes

Last updated: 2025-11-13 20:49:13

TerminateClusterNodes

Last updated: 2025-11-13 20:49:13

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to terminate cluster nodes.

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: TerminateClusterNodes.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	The instance ID.
CvmInstanceIds.N	Yes	Array of String	The list of resources to be terminated.
NodeFlag	Yes	String	Valid values of node type: MASTER TASK CORE ROUTER
GraceDownFlag	No	Boolean	The graceful scale-in feature. Valid values: `true`: Enabled. `false`: Disabled.
GraceDownTime	No	Integer	The graceful scale-in wait time in seconds. Value range: 60–1800.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	The scale-in process ID.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Terminating cluster nodes

This example shows you how to terminate cluster nodes.

Input Example

POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TerminateClusterNodes
<Common request parameters>

{
    "InstanceId": "emr-4zvc5mul",
    "CvmInstanceIds": [
        "ins-42u6moui"
    ],
    "NodeFlag": "MASTER",
    "GraceDownTime": 0,
    "GraceDownFlag": true
}

Output Example

{
    "Response": {
        "FlowId": 1000,
        "RequestId": "4d701c1e-8507-47e1-8c69-a8f06a236f24"
    }
}

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

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
InvalidParameter.InvalidNodeFlag	Incorrect node type.
InvalidParameter.InvalidResourceIds	Invalid resource ID.
ResourceInUse.InstanceInProcess	The instance is under workflow.
ResourceNotFound.CvmInstanceNotFound	Unable to find the specified CVM instance.
ResourceNotFound.InstanceNotFound	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud