创建设备-下级平台

最近更新时间:2025-02-21 02:50:53

1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制:500次/秒。

创建设备(下级平台)。

2. 请求参数

参数类型是否必选示例值描述
ActionStringCreateDevice操作接口名,系统规定参数。
GroupIdString32388483999平台所属组ID。
InProtocolStringgb28181使用的接入协议。
取值: gb28181
DirIdString600001平台所属目录ID。
DeviceTypeStringplatform设备类型。
取值: ipc, nvr, platform
GbIdString31011500011328110080平台的国标id
DeviceVendorStringhaikang设备厂商。
DeviceNameStringxxx视频监控平台平台名称。
DescriptionStringxxx视频监控平台平台描述。
DeviceIpString192.168.0.1平台IP。
DevicePortLong8080平台Port。
UserNameStringtestUser平台使用的用户名,在创建GB28181凭证时生成。
PullTypeLong1平台下的设备是否启用自动拉流,默认继承组PullType,但如果设置了该字段,则会覆盖组下面的PullType值。
仅gb28181组支持该字段。
取值:1, 2
取值为1,自动拉流,国标设备注册成功后自动启动拉流;
取值为2,按需拉流,需要通过触发的方式启动拉流。

3. 返回参数

参数类型描述
GroupIdString平台所属组ID。
GbIdString平台国标ID。
DeviceIdString平台ID。
CreatedTimeString平台创建时间。
UpdatedTimeString平台更新时间。
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=CreateDevice
&GroupId=742711514552598528
&InProtocol=gb28181
&DeviceType=platform
&DeviceName=test-platform
&UserName=user
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=%2FUKPWN9c6i1aUftJGt1OgUTqjck%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1262606746
&SignatureVersion=1.0
&Timestamp=1599108325

4.2 返回示例

{
  "GroupId": "742711514552598528",
  "GbId": "34082400011328848899",
  "DeviceId": "29942028422873997",
  "CreatedTime": "2020-09-03 12:45:32",
  "UpdatedTime": "2020-09-03 12:45:32",
  "RequestId": "1ad5d74c191949e7b09500f80f688ef0"
}

5. 错误码

ErrorCodeErrorMessage