# 批量停止实例 - BatchStopInstance
#### 功能介绍
批量对实例进行关机。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=BatchStopInstance)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项               | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名                         | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:stop | write | -           | -   | rds:instance:operateServer | -      |
   
#### 接口约束
- 最多支持批量停止50个实例。

- 该接口仅支持MySQL引擎。
- 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。
- 已停止的实例被删除后不会进入回收站。
- 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。
- 实例默认停止十五天，如果您在十五天内未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。
- 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。
- 实例在以下状态不能执行停止实例： 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。
  
 
#### URI
- URI格式 POST /v3/{project_id}/instances/batch/action/shutdown
  

- 参数说明
  表1参数说明 
  | 名称         | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称           | 是否必选 | 参数类型           | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| instance_ids | 是    | List\<String\> | **参数解释：** 实例ID列表。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求示例
批量停止实例。
```
POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/batch/action/shutdown
{
     "instance_ids" : [
        "5b409baece064984a1b3eef6addae50cin01"
       ]
}
```
#### 响应消息
- 正常响应要素说明
  表3要素说明 
  | 名称      | 参数类型 | 说明                                                                                                                                                                                |
  |:---|:---|:---|
  | records | List | **参数解释：** 停止结果记录。 详情请参见[表4]。 |
     
   表4records字段说明 
  | 名称          | 参数类型   | 说明                                                                                                                                                    |
  |:---|:---|:---|
  | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 |
  | job_id      | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。    |
     
  

- 正常响应样例
  ```
  {
      "records": [
          {
              "instance_id": "5b409baece064984a1b3eef6addae50cin01",
              "job_id": "2b414788a6004883a02390e2eb0ea227"
          }
      ]
  }
  ```
  

- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。