Zaoxu, Li 4edaa4a4cc ECS API 20231016 version

Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>

2024-04-29 11:04:13 +00:00

10 KiB

Raw Blame History

Starting ECSs in a Batch

Function

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

This API is an asynchronous API. After the batch start request is successfully delivered, a job ID is returned. This does not mean the batch start 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 start 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-start	Yes	Object	Specifies the operation to start the ECS. For details, see Table 3.

**Table 3** **os-start** field description
Parameter	Mandatory	Type	Description
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

Batch start ECSs whose IDs are 616fb98f-46ca-475e-917e-2563e5a8cd19 and 726fb98f-46ca-475e-917e-2563e5a8cd20 with the request parameter set to os-start.

POST https://{endpoint}/v1/{project_id}/cloudservers/action

{
    "os-start": {
        "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

10 KiB Raw Blame History