# 批量添加设备（仅支持GB28181协议）
#### 功能介绍
批量添加设备，仅支持GB28181协议，最大支持批量新增100个设备
#### URI
POST /v1/{user_id}/devices/gb/batch-add
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                |
|:---|:---|:---|:---|
| user_id | 是    | String | 用户ID：由数字组成，长度范围\[15,25\]，获取方式参考[获取user ID与下载AK/SK](https://support.huaweicloud.com/api-ivm/ivm_03_0005.html#ZH-CN_TOPIC_0000001710465704__section1213543912215)章节 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                    |
|:---|:---|:---|:---|
| Access-Token | 是    | String | 用户认证AccessToken：从[获取用户北向接口认证AccessToken](https://support.huaweicloud.com/api-ivm/ivm_03_0002.html)中获取 |
   
表3请求Body参数 
| 参数      | 是否必选 | 参数类型                                                                                                         | 描述                     |
|:---|:---|:---|:---|
| devices | 是    | Array of [BatchAddGBDevicesReqItem] objects | 设备信息列表：数组长度范围\[1,100\] |
   
 表4BatchAddGBDevicesReqItem 
| 参数              | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| device_id       | 是    | String | 设备ID。 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| device_name     | 是    | String | 设备名。 字符组成，支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围\[1,128\]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| device_username | 否    | String | 设备用户名。 支持大小写字母、数字、特殊字符（-），但不能以数字开头，长度范围\[5,32\]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| device_password | 是    | String | 设备在平台中的注册密码。 （1）密码长度范围\[8,32\] （2） 密码必须包含如下至少三种字符的组合：至少一个小写字母；至少一个大写字母；至少一个数字；至少一个特殊字符：\`\~!@#$%\^\&\*()-_=+\|\[{}\];:'",\<.\>/? 和空格。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| description     | 否    | String | 设备描述 支持中英文、数字 、特殊字符（_-空格） 字符组成，长度范围\[0,128\]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| algorithm       | 是    | String | 设备注册认证算法。 枚举类型，用于设备向云服务注册上线时的认证，选择SHA256时需要确认设备是否支持。 枚举值： - **MD5** md5加密算法   - **SHA256** sha256加密算法    说明： - MD5存在风险，请谨慎使用，建议使用SHA256鉴权方式。   |
   
#### 响应参数
**状态码： 200**
表5响应Body参数 
| 参数         | 参数类型                                                                                                            | 描述       |
|:---|:---|:---|
| failed_num | Integer                                                                                                         | 失败数量     |
| devices    | Array of [BatchAddGBDevicesRespItem] objects | 添加结果详细信息 |
   
 表6BatchAddGBDevicesRespItem 
| 参数                | 参数类型                                                            | 描述           |
|:---|:---|:---|
| device_id         | String                                                          | 设备ID，设备唯一标识符 |
| sip_server_id     | String                                                          | SIP服务器ID     |
| sip_server_domain | String                                                          | SIP服务器域      |
| sip_server_host   | String                                                          | SIP服务器地址     |
| sip_server_port   | String                                                          | SIP服务器端口     |
| result            | [Result] object | 错误或成功信息      |
   
 表7Result 
| 参数   | 参数类型   | 描述   |
|:---|:---|:---|
| code | String | 错误编码 |
| msg  | String | 错误信息 |
   
#### 请求示例
添加国标协议设备
```
POST /v1/2562572829***/devices/gb/batch-add
{
  "devices" : [ {
    "device_id" : "952352LWXT***",
    "device_name": "DEVICE01",
    "device_username" : "admin",
    "device_password" : "***",
    "algorithm": "MD5"
  } ]
}
```
#### 响应示例
**状态码： 200**
OK
```
{
  "failed_num" : 0,
  "devices" : [ {
    "device_id" : "952352LWXT***",
    "sip_server_id" : "3402000000***",
    "sip_server_domain" : "3402***",
    "sip_server_host" : "123.123.*.*",
    "sip_server_port" : "5060",
    "result" : {
      "code" : "IVM.0",
      "msg" : "Success"
    }
  } ]
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-ivm/ivm_03_0136.html)
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ivm/ivm_03_0137.html)