• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Server Actions
  6. Stop Server

Stop Server

Function Description

This interface is used to stop a single ECS.

URI

  • URI format

    POST /v2/{tenant_id}/servers/{server_id}/action

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

  • Parameter description

    Parameter

    Mandatory

    Description

    tenant_id

    Yes

    Specifies the tenant or project ID.

    server_id

    Yes

    Specifies the ECS ID.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    os-stop

    Yes

    Dictionary data structure

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

    Table 1 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
  • Example request
    {
        "os-stop": {}
    }

Response

N/A

Returned Values

See General Request Returned Values.