• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. Extension ECS APIs
  5. Status Management
  6. Stopping ECSs in a Batch

Stopping ECSs in a Batch

Function

This interface 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.

Request

Request parameters

Parameter

Mandatory

Type

Description

os-stop

Yes

Dictionary data structure

Specifies the operation to stop the ECS. For details, see Table 2.

Table 2 os-stop field description

Parameter

Mandatory

Type

Description

servers

Yes

List data structure

Specifies ECS IDs. For details, see Table 3.

type

No

String

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

SOFT: normal ECS stop (default)

HARD: forcible ECS stop

Table 3 servers field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ECS ID.

Response

See Responses (Task).

Examples

  • Example request
    NOTE:

    In the request parameters, the request for stopping the ECS must be issued with field os-stop, as shown in the example request.

    {
        "os-stop": {
            "type":"HARD",
            "servers": [
                {
                    "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
                },
                {
                    "id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
                }
    
            ]
        }
    }

Returned Values

See General Request Returned Values.

Error Code

See Error Code Description.