【2023年10月13日】边缘计算机器部分接口鉴权升级公告
【2022年06月01日】边缘计算机器网络带宽支持按天结算公告
Domain name for API request: ecm.intl.tencentcloudapi.com.
Only instances in RUNNING status can be shut down.
The instance status will become STOPPING when the API is called successfully and will become STOPPED when the instance is shut down successfully.
Forced shutdown is supported. Just like powering off a physical PC, a forced shutdown may cause data loss or file system corruption. Make sure that you use this API only when the server cannot be shut down normally.
A maximum of 20 requests can be initiated per second for this API.
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: 2019-07-19. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceIdSet.N | Yes | Array of String | List of IDs of the instances to be shut down. You can request up to 100 instances in a region at a time. |
| ForceStop | No | Boolean | Whether to force shut down the instance after it failed to be shut down normally. Default value: false: no. |
| StopType | No | String | Instance shutdown mode. Valid values: SOFT_FIRST: perform a forced shutdown in case of a failure of the normal shutdown; HARD: forced shutdown; SOFT: Soft shutdown; Default value: SOFT. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to shut down an instance.
https://ecm.intl.tencentcloudapi.com/?Action=StopInstances
&InstanceIdSet.0=ein-496721al
&InstanceIdSet.1=ein-438242bp
&ForceStop=false
&StopType=SOFT_FIRST
&<Common request parameters>{
"Response": {
"RequestId": "d40cdb72-7bc0-4b48-b3aa-25e8401f6999"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InstanceOwnerCheckFailed | The instance does not belong to the current module. |
| FailedOperation.InternalOperationFailure | Internal error. |
| FailedOperation.OperationNotAllow | The current operation is not allowed. |
| InvalidParameter.InvalidDataFormat | The data format is incorrect. |
| InvalidParameterValue.InvaildModifyParam | The parameter is incorrect. |
| InvalidParameterValue.InvalidInstanceID | The instance ID is invalid. |
| InvalidParameterValue.ParameterValueTooLarge | The parameter value exceeds the limit. |
| ResourceUnavailable.InstanceNotRunning | The instance is not running. |
| UnauthorizedOperation.ForbiddenOperation | You don't have the permission to perform this operation. |
文档反馈