创建设备
最近更新时间：2025-02-21 02:50:53
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。
创建设备（摄像头IPC、网络硬盘录像机NVR等）。
2. 请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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, platform |
| GbVersion | String | 否 | 2016 | 国标版本。 取值: 2011, 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(手动创建) |
| 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"}] | 资源包集合 |
| OrderAIApp | String | 否 | [{"Id": "72", "AnalyseType": "AI-200"}, {"Id": "278", "AnalyseType": "AI-100"}] | AI应用集合 |
| 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_AI ai包 VSS_UPLOAD_BW上行带宽包 | 资源类型 |
OrderAIApp
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Id | String | 是 | 72 | ai应用ID |
| AnalyseType | String | 是 | AI-200 | ai应用类型 |
3. 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 设备所属组ID。 |
| GbId | String | 设备国标ID。 |
| DeviceId | String | 设备ID。 |
| EhomeId | String | EhomeId。 |
| 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 | 视频流状态。 |
4. 示例
4.1 请求示例
https://vssapi.ctyun.cn/
?&Action=CreateDevice
&GroupId=569365715455623168
&InProtocol=gb28181
&DeviceType=ipc
&DeviceName=测试摄像头
&UserName=ttttt123
&GbRegion=51030300
&OrderResource=[{"ResourceId":"resource01_video_234test001","ResourceType":"VSS_VIDEO","WorkOrderId":"workorder01_video_test_0001"},{"ResourceId":"resource01_ai_test","ResourceType":"VSS_AI","WorkOrderId":"workorder01_ai_test"}]
&Version=2020-06-12
&AccessKeyId=WOSRUSPHCVMTCUVT****
&Signature=Sa9oxPfVpDX5XADc06RU8QScVS8=
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1631779384986537800
&SignatureVersion=1.0
&Timestamp=1631779384
4.2 返回示例
{
"GroupId":"569365715455623168",
"GbId":"51030300041327000384",
"DeviceId":"577628957656612864",
"CreatedTime":"2022-10-19 17:54:37",
"UpdatedTime":"2022-10-19 17:54:37",
"DeviceChannels":[],
"RequestId":"1fa78d63ff35458d9888be5721232474",
"EhomeId":""
}
5. 错误码
| ErrorCode | ErrorMessage |
|---|---|
本页目录：