Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Batch Operations/ Stopping ECSs in a Batch
Updated on 2025-12-10 GMT+08:00
View PDF
Share

Stopping ECSs in a Batch

Function

This API is used to stop ECSs in a batch based on specified ECS IDs. A maximum of 1,000 ECSs can be stopped in one minute.

This API is an asynchronous API. After the batch stop request is successfully delivered, a job ID is returned. This does not mean the batch stop is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the batch stop is successful.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:cloudServers:stop

write

instance *

-

-

-

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

Table 5 describes the response parameters.

Table 5 Response parameters

Parameter

Type

Description

job_id

String

Definition

Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.

Range

N/A

For details about abnormal responses, see Responses (Jobs).

Example Request

Batch stop ECSs whose IDs are 616fb98f-46ca-475e-917e-2563e5a8cd19 and 726fb98f-46ca-475e-917e-2563e5a8cd20 with the request parameter set to os-stop. 
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

{
    "job_id": "ff808082889bd9690189061140c235fe"
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Batch Operations