本接口用于停止一台或多台 ECS 实例,支持选择不同的停机方式、停机模式以及批量操作模式停止实例。
接口说明
该接口为异步接口,实例的停止不是立即完成的,成功调用后,实例会先进入停止中(Stoping)状态,你可以调用 DescribeInstanceStatus 查看实例状态,当返回的状态为Stopped 时代表停止成功。
使用须知
停止实例后实例不可用,请确认停止实例不会对您的业务造成影响。您可以调用 StartInstance 或 StartInstances 接口启动实例。
被安全锁定的实例不能通过调用该接口停止。更多信息,请参见资源安全锁定对调用 API 的影响。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:StopInstances |
update |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DryRun |
boolean |
否 |
是否发送预检请求。取值范围:
说明
如果参数
默认值:false。 |
false |
| RegionId |
string |
是 |
实例所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| ForceStop |
boolean |
否 |
是否强制关机。取值范围:
默认值:false。 |
false |
| StoppedMode |
string |
否 |
停止模式。取值:
默认值:如果您开启 VPC 内实例节省停机模式并符合开启条件,则默认值为 |
KeepCharging |
| BatchOptimization |
string |
否 |
设置批量操作模式。取值范围:
默认值:AllTogether。 |
AllTogether |
| InstanceId |
array |
是 |
实例 ID 数组。数组长度:1~100。 |
i-bp67acfmxazb4p**** |
|
string |
否 |
实例 ID。 |
i-bp67acfmxazb4p**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
1C488B66-B819-4D14-8711-C4EAAA13AC01 |
| InstanceResponses |
object |
||
| InstanceResponse |
array<object> |
由 InstanceResponse 组成的数组格式,返回每个实例操作的前后状态及操作结果。 |
|
|
object |
|||
| Code |
string |
实例操作结果错误码。返回值为 200 表示操作成功。更多信息,请参见下文错误码列表。 |
200 |
| Message |
string |
实例操作返回错误信息。返回值为 |
success |
| InstanceId |
string |
实例 ID。 |
i-bp67acfmxazb4p**** |
| CurrentStatus |
string |
实例当前状态。 |
Stopping |
| PreviousStatus |
string |
实例操作前状态。 |
Running |
示例
正常返回示例
JSON格式
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01",
"InstanceResponses": {
"InstanceResponse": [
{
"Code": "200",
"Message": "success",
"InstanceId": "i-bp67acfmxazb4p****",
"CurrentStatus": "Stopping",
"PreviousStatus": "Running"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be added ECS tag | |
| 400 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service account have no right to access your KMS. | ECS 服务无权访问您的 KMS |
| 400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | 您设置了预检此次请求,并且检查通过。 |
| 400 | InvalidParameter.Encrypted.KmsNotEnable | Failed to perform this operation because KMS is not activated. | 您需要开通KMS密钥托管服务。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | InvalidInstanceId.NotFound | InstanceId should not be null. | |
| 403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | InstanceIds列表长度超过100。 |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | 指定的InstanceId参数不合法 |
| 403 | InstanceLockedForSecurity | %s | |
| 403 | InstanceExpiredOrInArrears | %s | |
| 403 | IncorrectInstanceStatus | %s | 当前实例的状态不支持此操作。 |
| 403 | InvalidInstanceId.NotSupport | %s | |
| 403 | InsufficientBalance | Your account does not have enough balance. | |
| 403 | InstanceNotReady | The specified instance is not ready for use. | |
| 403 | InvalidOperation.KMSKeyIdNotFound | The specified KMSKeyId not found, %s. | 无法找到关联的KMS加密密钥,请确认该KMS加密密钥有效性。 |
| 403 | InvalidOperation.KMSServiceNotOpen | KMS service is currently not open. | KMS服务尚未启用. |
| 403 | OperationDenied.SystemInstanceNotSupport | The system instance does not support the %s operation because %s. | |
| 404 | InvalidInstanceId.NotFound | %s | |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。请检查 InstanceId 参数值是否正确。您可以调用 DescribeInstances 查询指定实例的状态。 |
| 503 | LimitedOperation.ServiceUnavailable | The service is currently unavailable. Please try again later. | 当前服务不可用。请稍后重试。 |
| 409 | InvalidOperation.Conflict | Request was denied due to conflict with a previous request, please try again later. | 请求操作的资源与之前的请求冲突 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。