创建设备-下级平台
最近更新时间:2025-02-21 02:50:53
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制:500次/秒。
创建设备(下级平台)。
2. 请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDevice | 操作接口名,系统规定参数。 |
GroupId | String | 是 | 32388483999 | 平台所属组ID。 |
InProtocol | String | 是 | gb28181 | 使用的接入协议。 取值: gb28181 |
DirId | String | 否 | 600001 | 平台所属目录ID。 |
DeviceType | String | 是 | platform | 设备类型。 取值: ipc, nvr, platform |
GbId | String | 是 | 31011500011328110080 | 平台的国标id |
DeviceVendor | String | 否 | haikang | 设备厂商。 |
DeviceName | String | 否 | xxx视频监控平台 | 平台名称。 |
Description | String | 否 | xxx视频监控平台 | 平台描述。 |
DeviceIp | String | 否 | 192.168.0.1 | 平台IP。 |
DevicePort | Long | 否 | 8080 | 平台Port。 |
UserName | String | 是 | testUser | 平台使用的用户名,在创建GB28181凭证时生成。 |
PullType | Long | 否 | 1 | 平台下的设备是否启用自动拉流,默认继承组PullType,但如果设置了该字段,则会覆盖组下面的PullType值。 仅gb28181组支持该字段。 取值:1, 2 取值为1,自动拉流,国标设备注册成功后自动启动拉流; 取值为2,按需拉流,需要通过触发的方式启动拉流。 |
3. 返回参数
参数 | 类型 | 描述 |
---|---|---|
GroupId | String | 平台所属组ID。 |
GbId | String | 平台国标ID。 |
DeviceId | String | 平台ID。 |
CreatedTime | String | 平台创建时间。 |
UpdatedTime | String | 平台更新时间。 |
RequestId | String | 唯一请求 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. 错误码
ErrorCode | ErrorMessage |
---|---|
本页目录: