Help Center/ Bare Metal Server/ API Reference/ Native OpenStack Nova V2.1 APIs/ BMS Status Management/ Stopping a BMS (Native OpenStack API)
Updated on 2024-05-17 GMT+08:00
View PDF

Stopping a BMS (Native OpenStack API)

Function

This API is used to stop a single BMS. To stop multiple BMSs, you can use the Stopping BMSs API.

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 details about how to obtain the project ID, see Obtaining a Project ID.

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 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 field data structure description

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