• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Status Management
  6. Stopping an ECS

Stopping an ECS

Function

This API is used to stop 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.

server_id

Yes

Specifies the ECS ID.

Request

Request parameters

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

os-stop

Yes

Dictionary data structure

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

Table 3 os-stop field description

Parameter

Mandatory

Type

Description

type

No

String

Specifies an ECS stop type. The default value is SOFT.

  • SOFT: normal ECS stop
  • HARD: forcible ECS stop

Response

N/A

Examples

  • Example request
    {
        "os-stop": {}
    }

Returned Values

See General Request Returned Values.