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 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 Task Execution Status to query the job status. The SUCCESS status indicates that the batch stop is successful.

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.

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¶

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.

last updated: 2024-11-13 15:01 UTC - commit: cd2be11cc19cf5d8dfd3a6caf2d1429e1bff9d8a