关闭实例
1. 接口描述
调用 StopInstance 接口停止一台已启动（STARTED）的实例。成功调用接口后，实例从停止中（STOPPING）变成已停止（STOPPED）状态。
注意：实例状态必须为已启动（STARTED）。
2. 请求参数
| 参数名 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Action | String | 是 | 固定取值：StopInstance |
| RegionCode | String | 是 | 实例所属的地域编码，您可以调用 DescribeRegionConfig 查看最新的地域列表 |
| ZoneCode | String | 是 | 实例所属的可用区编码，您可以调用 DescribeZoneConfig 查看可用区列表 |
| InstanceUUID | String | 是 | 实例ID |
| ForceStop | Boolean | 否 | 是否强制停止。取值范围: true 是 false 否 |
3. 返回数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| RequestId | String | 请求ID |
4. 示例
请求示例
https://openapi.kaopuyun.com/?SignatureVersion=1.0
&Action=StopInstance
&Format=JSON
&InstanceUUID=ecs-3m0000gftg8m
&SignatureNonce=fad368fd-b5e3-476b-903b-2ef34e0e9fba
&Version=2014-05-26
&AccessKeyId=hfWkfqG6a794
&Signature=IcyHYfUBWSzJauAbDaqniNSNE94=
&SignatureMethod=HMAC-SHA1
&Timestamp=2023-02-25T15:29:21Z
&RegionCode=cn-fuzhou-1
&ZoneCode=cn-fuzhou-1-a
正常返回示例
{
"RequestId":"742fbe80-0ea9-11eb-9b36-0208cb7f7896"
}
5. 错误码
| 错误码 | 错误信息 |
|---|---|
| MissingParameter | RegionCode 参数不能为空 |
| MissingParameter | ZoneCode 参数不能为空 |
| AvailiableInstanceNotFound | 可用实例未找到 |
| IncorrectInstanceStatus.Locked | 非法实例状态--已锁定 |
| IncorrectInstanceStatus | 该实例目前的状态不支持此操作 |
| StopInstanceFail | 关闭实例失败:xxx |