Restarting or Deleting Instances in Batches
This API is an out-of-date version and may not be maintained in the future. Please use the API described in Batch Restarting or Deleting Instances.
Function
This API is used to restart or delete instances in batches.
When an instance is being restarted, message retrieval and creation requests of the client will be rejected.
Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.
Request
Request
Table 2 describes the request parameters.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| action | String | Yes | Indicates the operation to be performed on instances. The value of this parameter can be restart or delete. |
| instances | Array | Yes | Indicates the list of instance IDs. |
| allFailure | String | No | Indicates whether to delete instances that fail to be created in batches. If this parameter is set to true, all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty. |
Example request
Restarting instances in batches:
{
"action" : "restart",
"instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"]
} Deleting instances in batches:
{
"action" : "delete",
"instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"]
} Deleting all instances that fail to be created:
{
"action" : "delete",
"allFailure" : "true"
} Response
Response parameters
When action is set to delete, allFailure is set to true, and an empty response is returned, the instances are deleted successfully. Table 3 describes the parameters.
| Parameter | Type | Description |
|---|---|---|
| results | Array | Indicates the result of instance modification. |
| Parameter | Type | Description |
|---|---|---|
| instance | String | Indicates the instance ID. |
| result | String | Indicates an operation result, which can be success or failed |
Example response
{
"results": [
{
"result": "success",
"instance": "afc90a2a-a02c-4cba-94d5-58dfa9ad1e0d"
},
{
"result": "success",
"instance": "67fc5f8d-3986-4f02-bb75-4075a23112de"
}
]
} Status Code
Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.
Last Article: Deleting an Instance
Next Article: Querying All Instances
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.