功能介绍
默认接口请求频率限制：500次/秒。
创建设备（摄像头IPC、网络硬盘录像机NVR等）。
接口约束
- 创建设备之前，确保该账号下存在资源包。
- 创建设备之前，确保已创建业务组、国标凭证。
- 同一业务组下,设备名称不可重复。
- 同一用户下,SerialNumber唯一。
- 若创建NVR-通道,其设备类型为ipc。
- 若手动创建nvr设备的通道，请先确认nvr设备为手动创建通道类型，然后请求参数ParentDeviceId为nvr设备的id，请求参数DeviceType为ipc。
URL
GET /v1?
请求参数
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Action |
String |
是 |
CreateDevice |
操作接口名，系统规定参数。 |
| GroupId |
String |
是 |
32388483999 |
设备所属组ID。 |
| InProtocol |
String |
是 |
gb28181 |
使用的接入协议。取值: gb28181 |
| ParentDeviceId |
String |
否 |
32387732995 |
上级设备ID，比如摄像头所属的NVR设备ID，创建NVR通道时需要此参数。 |
| DirId |
String |
否 |
600001 |
设备所属目录ID。 |
| DeviceType |
String |
是 |
nvr |
设备类型。取值: ipc, nvr。ipc既可以是主设备也可以是通道设备（子设备），nvr只能是主设备。该字段不能修改，应为设备本身的类型。 |
| GbVersion |
String |
是 |
2016 |
国标版本。取值: 2016。仅ipc设备和nvr设备需要此参数。 |
| DeviceVendor |
String |
是 |
海康 |
设备厂商，长度不超过64位。取值：海康，大华，宇视，科达，金三立，华为，其他。 |
| DeviceName |
String |
是 |
xxx路口摄像头 |
设备名称，长度为2-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。 |
| Description |
String |
否 |
xxx路口摄像头 |
设备描述，长度不超过255个字符。 |
| DeviceIp |
String |
否 |
192.168.0.1 |
设备IP。 |
| DevicePort |
Long |
否 |
8080 |
设备Port，范围0-65535。 |
| UserName |
String |
是 |
testUser |
设备用户名，在创建GB28181凭证时生成。 |
| PullType |
Long |
否 |
1 |
是否启用自动拉流，默认继承组PullType，但如果设置了该字段，则会覆盖组下面的PullType值。取值：1, 2取值为1，自动拉流，国标设备注册成功后自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| TransPriority |
String |
否 |
tcp |
设备视频流优先传输协议，默认tcp。取值：tcp, udp。取值为tcp，如果设备支持tcp协议传输，设备进行视频邀约时优先使用tcp协议接入到vss服务中。取值为udp，设备进行视频邀约时优先使用udp协议接入到vss服务中。 |
| ChannelSize |
Long |
否 |
10 |
设备通道数量，nvr设备时才需要填写，最多创建256个通道。 |
| CreateSubDevice |
Long |
否 |
1 |
是否自动创建子设备，默认1。取值：1(自动创建), 2(手动创建)。取值为1时，ChanelNum和ChanelName无需填写。 |
| ChannelNum |
Long |
否 |
1 |
手动创建子设备时，需指定通道号 |
| ChannelName |
String |
否 |
通道1 |
手动创建子设备时，需指定通道名称，长度为2-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。 |
| GbRegion |
String |
是 |
51030300 |
设备区域编码，编码长度为8位。字段值为空时，默认继承业务组所属区域取值按照用户或设备所归属的监控中心所在地的行政区划代码确定 。 |
| GbRegionLevel |
Long |
否 |
3 |
设备区域级别，编码长度为1位。 |
| IndustryCode |
String |
否 |
04 |
设备行业编码，编码长度为2位。IndustryCode值为空时默认继承业务组所属行业。行业编码是指用户或设备所归属的行业。 |
| NetworkCode |
String |
否 |
7 |
设备的网络标识。取值如下：0、1、2、3、4 为监控报警专网，5 为公安信息网，6 为政务网，7 为 Internet 网，8 为社会资源接入网，9 预留。 |
| OrderResource |
String |
是 |
[{"ResourceId":"resource10","ResourceType":"VSS_VIDEO","WorkOrderId":"work_order_10"}] |
资源包集合。手动创建通道设备时，不需要资源包，默认继承nvr设备资源包。该字段传对应json字符串。 |
| OrderAIApp |
String |
否 |
[{"Id": "72", "AnalyseType": "AI-200"}, {"Id": "278", "AnalyseType": "AI-100"}] |
AI应用集合。该字段传对应json字符串。 |
| SerialNumber |
String |
否 |
123xxx |
设备SN码，长度不超过64位。 |
| DeviceModel |
String |
否 |
123xxx |
设备型号，长度不超过64位。 |
OrderResource
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| WorkOrderId |
String |
是 |
work_order_10 |
订单ID。 |
| ResourceId |
String |
是 |
resource10 |
资源ID。 |
| ResourceType |
String |
是 |
VSS_VIDEO |
资源类型。取值：VSS_VIDEO：视频包，VSS_AI：ai包，VSS_UPLOAD_BW：上行带宽包。 |
OrderAIApp
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Id |
String |
是 |
72 |
ai应用ID |
| AnalyseType |
String |
是 |
AI-200 |
ai应用类型 |
返回参数
| 参数 |
类型 |
描述 |
| GroupId |
String |
设备所属组ID。 |
| GbId |
String |
设备国标ID。 |
| DeviceId |
String |
设备ID。 |
| CreatedTime |
String |
设备创建时间。 |
| UpdatedTime |
String |
设备更新时间。 |
| DeviceChannels |
DeviceChannel[] |
ipc设备忽略该字段；nvr设备时，才返回。 |
| RequestId |
String |
唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
DeviceChannel
| 参数 |
类型 |
描述 |
| ChannelNum |
Long |
通道号。 |
| ChannelName |
String |
通道名称。 |
| GbId |
String |
设备国标ID。 |
| DeviceId |
String |
设备ID。 |
| DeviceStreams |
DeviceStream[] |
设备视频流信息。 |
| CreatedTime |
String |
子设备（通道）创建时间。 |
| UpdatedTime |
String |
子设备（通道）更新时间。 |
DeviceStream
| 参数 |
类型 |
描述 |
| StreamNum |
Long |
视频流编号。 |
| StreamStatus |
String |
视频流状态。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=CreateDevice&Description=%E8%AE%BE%E5%A4%87%E6%8F%8F%E8%BF%B0&DeviceIp=192.168.0.1&DeviceModel=IPC%E8%AE%BE%E5%A4%87&DeviceName=create1i1&DevicePort=8080&DeviceType=ipc&DeviceVendor=%E6%B5%B7%E5%BA%B7&DirId=0&GbRegion=51030300&GbRegionLevel=3&GbVersion=2016&GroupId=556002285492715528&InProtocol=gb28181&IndustryCode=10&NetworkCode=7&OrderAIApp=%5B%7B%22Id%22%3A+%22351%22%2C+%22AnalyseType%22%3A+%22AI-100%22%7D%2C+%7B%22Id%22%3A+%22355%22%2C+%22AnalyseType%22%3A+%22AI-300%22%7D%2C+%7B%22Id%22%3A+%22358%22%2C+%22AnalyseType%22%3A+%22AI-200%22%7D%5D%09&OrderResource=%5B%7B%22ResourceId%22%3A%22resource01_video_234test001%22%2C%22ResourceType%22%3A%22VSS_VIDEO%22%2C%22WorkOrderId%22%3A%22workorder01_video_test_0001%22%7D%2C%7B%22ResourceId%22%3A%22resource01_ai_test%22%2C%22ResourceType%22%3A%22VSS_AI%22%2C%22WorkOrderId%22%3A%22workorder01_ai_test%22%7D%5D&PullType=1&SerialNumber=%E8%AE%BE%E5%A4%87SN%E7%A0%8101&TransPriority=tcp&UserName=ttttt123
Connection: keep-alive
ctyun-eop-request-id: 66d73336-d8cb-4049-8feb-ca7d2c80255a
Eop-date: 20221025T093445Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=1VVQrdEtn67Qg32wk6rc5OGZJFC1OzCgu+x7jrG5a3I=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13
返回示例
{
"GroupId": "556002285492715528",
"GbId": "51030300101327017396",
"DeviceId": "581824359021756416",
"CreatedTime": "2022-10-25 09:34:46",
"UpdatedTime": "2022-10-25 09:34:46",
"DeviceChannels": [
],
"RequestId": "49bea5bc4451442f80c9ecbdc594d144",
"EhomeId": ""
}
错误码
错误码
