停止实例（批量停止）
更新时间：2024-07-02
该接口用于批量停止指定实例。
- 系统后台会在实例实际Stop成功后进入“已停止”状态。
- 只有状态全部为Running的实例才可以进行此操作，否则提示409错误。
- 实例支持强制停止，强制停止等同于断电处理，可能丢失实例操作系统中未写入磁盘的数据。
- 只有全部实例都满足条件时，批量关机不计费才会生效，可调用查询可关机不计费的实例列表接口查询支持关机不计费的实例列表。
请求结构
PUT /v{version}/instance/batchAction?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"instanceIds": ["instanceId1","instanceId2"],
"forceStop":forceStop,
"stopWithNoCharge": stopWithNoCharge
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| action | String | 是 | Query参数 | 对实例执行的动作，本接口中该参数取值：stop |
| instanceIds | List | 是 | Request Body参数 | 实例id组成的集合 |
| forceStop | Boolean | 否 | RequestBody参数 | 指定实例是否强制关机，可选值：true、false，缺省为false |
| stopWithNoCharge | Boolean | 否 | RequestBody参数 | 指定实例是否关机不计费，可选值：true、false，缺省为false |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数。
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Instance.StopInstanceOperationForbidden | Instance not running when shutting down | 409 | 只有 Running 状态的实例才可以进行关机 |
| Bcc.PrePayCannotStopWithNoCharge | pre pay instance can not stop with no charge. | 403 | 预付费实例不能进行关机不计费 |
| Bcc.Rocv1CannotStopWithNoCharge | Shutdown no charge feature is not available for instances with local disk. | 403 | 关机不收费功能不适用于带有本地盘的实例 |
| Bcc.InstanceTypeNotSupportException | Shutdown no charge feature is not available for this type of instance. | 403 | 关机不收费功能不适用于该类型实例 |
| Bcc.InstanceTypeNotSupportException | The instance is in the state of shutdown and no charge. This operation is not supported.If you need to do this, please cancel the shutdown and not charge. | 403 | 实例正处于关机不收费状态中，不支持该操作，如需进行此操作，请先取消关机不计费 |
| Instance.StopInstanceOperationForbidden | Instance not running when shutting down | 409 | 只有 Running 状态的实例才可以进行关机 |
| Bcc.StopWithNoChargeForbidden | batch stop with no charge failed. + {[instanceId1,instanceId2]:errMsg} | 409 | 批量关机不计费操作失败，{实例id：不支持的原因} |
请求示例
PUT /v2/instance/batchAction?stop HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"instanceIds": ["instanceId1"],
"forceStop":false,
"stopWithNoCharge": true
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS