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.
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. |
Request
Table 2 describes the request parameters.
Parameter | Mandatory | Type | Description |
---|---|---|---|
os-stop | Yes | Object | Specifies the operation to stop the ECS. For details, see Table 3. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
type | No | String | Specifies an ECS stop type. The default value is SOFT.
|
Response
None
Example Request
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
{"os-stop": {}}
Example Response
None
Returned Values
Parent topic: Status Management
- Function
- URI
- Request
- Response
- Example Request
- Example Response
- Returned Values