All Products
Search
Document Center

ENS:StopInstance

Last Updated:Apr 16, 2024

Stops an instance.

Operation description

  • You can call this operation to stop instances that are only in the Running state.
  • If the call is successful, the state of the instance becomes Stopping.
  • Once the instance is stopped, the state of the instance becomes Stopped.
  • Force stop is supported, which is equivalent to power-off. Data that is not written to disks on the instance may be lost.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance that you want to stop. You can specify only one instance ID.

i-instanceid****
ForceStopstringNo

Specifies whether to forcibly stop the servers.

  • true: forcibly stops the instance.
  • false: normally stops the servers. This is the default value.
true

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The returned service code. 0 indicates that the request was successful.

0
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.-
400InstanceIdNotFoundThe input parameter instancdId that is not found.-
400NoPermissionPermission denied.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version