Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Batch Operations> Stopping ECSs in a Batch
View PDF

Stopping ECSs in a Batch

Function

This API is used to stop ECSs in a batch based on the specified ECS ID list. A maximum of 1000 ECSs can be stopped at a time.

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 Request parameters

Parameter

Mandatory

Type

Description

os-stop

Yes

Object

Specifies the operation to stop the ECS. For details, see Table 3.
Table 3 os-stop field description

Parameter

Mandatory

Type

Description

servers

Yes

Array of objects

Specifies ECS IDs. For details, see Table 4.

type

No

String

Specifies an ECS stop type. The default value is SOFT.

SOFT: normal ECS stop (default)

HARD: forcible ECS stop
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 parameters, the request for stopping the ECS must be issued with field os-stop, as shown in the example request. 
POST https://{endpoint}/v1/{project_id}/cloudservers/action
{
    "os-stop": {
        "type":"HARD",
        "servers": [
            {
                "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
            },
            {
                "id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
            }

        ]
    }
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Code Description.

Parent topic: Batch Operations