Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Batch Operations/ Restarting ECSs in a Batch
Updated on 2023-05-29 GMT+08:00
View PDF

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.

URI

POST /v1/{project_id}/cloudservers/action

Table 1 describes the parameters in the URI.
Table 1 Parameter description

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.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

reboot

Yes

Object

Specifies the operation to restart the ECS. For details, see Table 3.
Table 3 reboot field description

Parameter

Mandatory

Type

Description

type

Yes

String

Specifies the type of the restart operation.

  • SOFT: soft restart
  • HARD: forcible restart (hard restart)

servers

Yes

Array of objects

Specifies ECS IDs. For details, see Table 4.
Table 4 servers field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ECS ID.

Response

See Responses (Task).

Example Request

In the request, the parameters to restart ECSs must be sent with field reboot. For details, see the example request. 
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": "70a599e0-31e7-49b7-b260-868f441e862b" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Batch Operations