Stopping an ECS

Updated on 2022-09-23 GMT+08:00

View PDF

This API is used to stop a single ECS.

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. For details about how to obtain the ID, see Obtaining a Project ID.
server_id	Yes	Specifies the ECS ID.

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

None

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

{
    "os-stop": {}
}

None

Parent topic: Status Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel