创建GB/T28181设备通道
功能介绍
此接口用于创建GB/T28181设备（摄像头、网络硬盘录像机等）通道。创建成功之后，自动为GB/T28181设备生成设备ID，以及选择关联的GB/T28181凭证。用户在设备注册时使用该设备ID与凭证，作为设备的用户名以及认证ID址。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
普通租户的token。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
type |
是 |
String |
设备类型，目前仅支持IPC和NVR类型的设备，不区分大小写。 |
username |
是 |
String |
关联的GB/T28181设备密码对应的用户名。 |
quantity |
否 |
Integer |
创建设备的个数。最小值为1，最大值为用户当前可以创建设备的剩余配额，不填该参数时默认值为1。 |
description |
否 |
String |
设备的描述，可填字符串最大长度为500。 |
suffix |
否 |
String |
设备通道关联的视频流名称后缀。国标设备注册后，会自动创建该设备关联的视频流，视频流的名称可以添加suffix字段作为名称后缀以帮助用户更好区分不同的视频流。后缀长度为0位到30位之间（长度为0时表示不设置后缀），可以包含字母、数字、中划线（-）或者下划线（_），不能包含其他的特殊字符。 |
auto_invite |
否 |
Boolean |
是否开启自动邀约，取值范围如下。
默认值为false。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
device_id_list |
Array of strings |
创建成功的设备ID列表。 |
请求示例
POST /v1/3266392d188c47d09948b1**********/devices
{
"type" : "IPC",
"username" : "0000",
"quantity" : 2,
"suffix" : "abc",
"description" : "description for device"
}
响应示例
状态码： 200
正常
{
"device_id_list" : [ "34020000001300******", "34020000001300******" ]
}
状态码： 400
请求错误。具体返回错误码请参考错误码说明
{
"error_msg" : "The username of GB28181 password is not found.",
"error_code" : "VIS.0102"
}
状态码
状态码 |
描述 |
|---|---|
200 |
正常 |
400 |
请求错误。具体返回错误码请参考错误码说明 |
