1. API Description
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to batch remove CVM instances from specified placement groups.
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.
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: DeleteInstancesDisasterRecoverGroups. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-12. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| InstanceIds.N |
Yes |
Array of String |
One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the return value from the API DescribeInstances. The maximum number of instances per request is 100. |
| DisasterRecoverGroupIds.N |
Yes |
Array of String |
ID list of placement groups, obtainable via the DescribeDisasterRecoverGroups API. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| 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 Batch remove CVM instances from specified placement groups
Remove CVM instance ins-23sh03x7 from placement group ps-c119a27y.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteInstancesDisasterRecoverGroups
<Common request parameters>
{
"InstanceIds": [
"ins-23sh03x7"
],
"DisasterRecoverGroupIds": [
"ps-c119a27y"
]
}
Output Example
{
"Response": {
"RequestId": "7c43bdac-5c17-4c35-8bb7-7d5aff400472"
}
}
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.DisasterRecoverGroupNotFound |
The specified placement group does not exist. |
| FailedOperation.DisasterRecoverGroupNotMatch |
The placement group information of the instance is mismatched. |
| InvalidParameterValue.DisasterRecoverGroupIdMalformed |
Incorrect placement group ID format. |
| InvalidParameterValue.InstanceIdMalformed |
Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
| ResourceNotFound.InvalidInstanceIdNotFound |
Instance ID not found. |