Restarting ECSs in a Batch¶
Function¶
This API is used to restart ECSs in a batch based on specified ECS IDs. A maximum of 1,000 ECSs can be restarted in one minute.
This API is an asynchronous API. After the batch restart request is successfully delivered, a job ID is returned. This does not mean the batch restart is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the batch restart is successful.
URI¶
POST /v1/{project_id}/cloudservers/action
Table 1 describes the parameters in the URI.
Parameter | Mandatory | Description |
|---|---|---|
project_id | Yes | Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
Request¶
Table 2 describes the request parameters.
Parameter | Mandatory | Type | Description |
|---|---|---|---|
reboot | Yes | Object | Specifies the operation to restart the ECS. For details, see Table 3. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
type | Yes | String | Specifies the type of the restart operation.
|
servers | Yes | Array of objects | Specifies ECS IDs. For details, see Table 4. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
id | Yes | String | Specifies the ECS ID. |
Response¶
See Responses (Task).
Example Request¶
Batch restart ECSs whose IDs are 616fb98f-46ca-475e-917e-2563e5a8cd19 and 726fb98f-46ca-475e-917e-2563e5a8cd20 with the request parameter set to reboot.
POST https://{endpoint}/v1/{project_id}/cloudservers/action
{
"reboot": {
"type":"SOFT",
"servers": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
},
{
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
}
]
}
}
Example Response¶
{
"job_id": "ff80808288d41e1b018990260955686a"
}
Returned Values¶
Error Codes¶
See Error Codes.