Updated on 2023-07-17 GMT+08:00

Restarting an ECS

Function

This API is used to restart a single ECS.

URI

POST /v2.1/{project_id}/servers/{server_id}/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.

server_id

Yes

Specifies the ECS ID.

Request

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

reboot

Yes

Object

Specifies the operation to restart the ECS. For details, see Table 3.

Table 3 reboot field description

Parameter

Mandatory

Type

Description

type

Yes

String

Specifies the type of the restart operation.

  • SOFT: soft restart
  • HARD: forcible restart (hard restart)

Response

None

Example Request

Restart a specified ECS.

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action

{
    "reboot": {
        "type": "SOFT"
    }
}

Example Response

None