doc-exports/docs/ecs/api-ref/en-us_topic_0020212652.html

Stopping an ECS

Function

This API is used to stop a single ECS.

URI

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

POST /v2/{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

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter	Mandatory	Type	Description
os-stop	Yes	Object	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

None

Example Request

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action

{
    "os-stop": {}
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Parent topic: Status Management