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

2023-10-11 08:28:11 +00:00

12 KiB

Raw Permalink Blame History

Restarting a BMS (Native OpenStack API)

Function

This API is used to restart a single BMS.

Constraints

Currently, only forcible restart is supported.

URI

POST /v2.1/{project_id}/servers/{server_id}/action

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For how to obtain the project ID, see Obtaining Required Information.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).

Request

Request parameters

Parameter	Mandatory	Type	Description
reboot	Yes	Object	Specifies the operation of restarting the BMS. For details, see Table 2.

**Table 2** **reboot** field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the type of the restart operation. SOFT: soft restart HARD: forcible restart NOTE: Currently, value SOFT is invalid. All BMS restart operations are forcible restart.

Example request

1
POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action

1
2
3
4
5
{
    "reboot": {
        "type": "HARD"
    }
}

Response

N/A

Returned Values

Normal values

Returned Values	Description
204	The server has processed the request but did not return any content.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS Status Management

12 KiB Raw Permalink Blame History