Files

wanghuijuan738 69783f9e3e bms api 20241225 version

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

2025-07-16 09:58:55 +00:00

16 KiB

Raw Blame History

Stopping a BMS

Function

This API is used to stop a single BMS.

This API has been deprecated. Use the API in Stopping BMSs.

Constraints

The OS-EXT-STS:vm_state attribute (BMS status) must be active or error.
Currently, only forcible stopping 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 API Querying BMSs.

Request Parameters

Parameter	Mandatory	Type	Description
os-stop	Yes	Object	Specifies the operation of stopping the BMS. For details, see Table 2.

**Table 2** **os-stop** data structure
Parameter	Mandatory	Type	Description
type	No	String	Specifies the type of the BMS stopping operation. SOFT: normal BMS stopping HARD: Forcible BMS stopping NOTE: Currently, this parameter is invalid. All BMS stopping operations are forcible stopping.

Example Request

Stopping a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd)

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

1
2
3
{
    "os-stop": {}
}

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 (OpenStack Nova APIs)

16 KiB Raw Blame History