tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud LighthouseInstance APIsStopInstances
StopInstances
Last updated: 2023-12-04 16:31:55
StopInstances
Last updated: 2023-12-04 16:31:55

1. API Description

Domain name for API request: lighthouse.tencentcloudapi.com.

This API is used to shut down one or more instances.

  • You can only perform this operation on instances whose status is RUNNING.
  • The instance status will become STOPPING when the API is called successfully and will become STOPPED when the instance is successfully shut down.
  • Batch operations are supported. The maximum number of instances in each request is 100.
  • This API is async. After the request is sent successfully, a RequestId will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: StopInstances.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region No String Common Params. This parameter is not required for this API.
InstanceIds.N Yes Array of String Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Shutting down instances

This example shows you how to shut down two instances.

Input Example

https://lighthouse.tencentcloudapi.com/?Action=StopInstances
&InstanceIds.0=lhins-ruy9d2tw
&InstanceIds.1=lhins-rusdke45
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "5fd6992a-f8b1-4cd2-9574-cb4251bc524f"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.DescribeInstanceStatus An error occurred when querying the instance status.
FailedOperation.InstanceOperationFailed Failed to manipulate the instance.
InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
OperationDenied.InstanceOperationInProgress It is not allowed to manipulate this instance, as the last operation is still in progress.
ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.NoPermission No permission
UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon