本接口用于停止一台ECS实例,支持选择不同的停机方式、停机模式以及批量操作模式停止实例。
接口说明
该接口为异步接口,实例的停止不是立即完成的,成功调用后,实例会先进入停止中(Stoping)状态,你可以调用 DescribeInstanceStatus 查看实例状态,当返回的状态为Stopped 时代表启动成功。
使用须知
被安全锁定的实例不能通过调用该接口停止。更多信息,请参见资源安全锁定对调用 API 的影响。
开启 VPC 内实例节省停机模式后,您可以通过设置
StoppedMode=KeepCharging开启普通停机模式,ECS 实例停止后会继续计费,并为您保留 ECS 实例规格库存和公网 IP 地址。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:StopInstance |
update |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定的实例 ID。 |
i-bp67acfmxazb4ph**** |
| ConfirmStop |
boolean |
否 |
该参数即将被弃用,为提高兼容性暂作保留。您在调用该接口时请忽略该参数。 |
true |
| ForceStop |
boolean |
否 |
停止实例时的是否强制关机策略。取值范围:
默认值为 false。 |
false |
| StoppedMode |
string |
否 |
停止按量付费 ECS 实例时,设置的停止模式。取值:
默认值:如果您在 ECS 控制台上开启 VPC 内实例节省停机模式(更多信息,请参见打开默认启用节省停机模式),并符合开启条件,则默认值为 |
KeepCharging |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值范围:
默认值为 false。 |
true |
| Hibernate |
boolean |
否 |
说明
该参数正在邀测中,暂不支持使用。 |
hide |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
1C488B66-B819-4D14-8711-C4EAAA13AC01 |
示例
正常返回示例
JSON格式
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
异常返回示例
JSON格式
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.Encrypted.KmsNotEnable | Failed to perform this operation because KMS is not activated. | 您需要开通KMS密钥托管服务。 |
| 400 | DiskError | IncorrectDiskStatus. | 指定的磁盘状态不合法。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | |
| 403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | 实例被安全锁定。 |
| 403 | InstanceType.ParameterMismatch | The input parameter ConfirmStop must be true when an instance have localstorage. | 当实例使用本地存储时,输入参数 ConfirmStop 必须为 true。 |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | |
| 403 | InvalidInstanceId.NotSupport | Classic network Instance does not support this operation. | 经典网络类型的实例不支持此操作。 |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag | |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服务无权访问您的 KMS。 |
| 403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | 不符合开启休眠选项的实例的相关限制,操作不被允许。 |
| 403 | HibernationConfigured.NotEnabled | The instance hibernation configured option is not enabled. | |
| 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 | The specified InstanceId does not exist. | 指定的实例ID无效。 |
| 503 | LimitedOperation.ServiceUnavailable | The service is currently unavailable. Please try again later. | 当前服务不可用。请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。