接口描述
默认接口请求频率限制:500次/秒。
修改设备信息。
接口约束
- 修改设备之前,确保此设备存在,未删除。
- 同一业务组下,设备名称不可重复。
- 同一用户下,SerialNumber唯一。
- 修改nvr子通道数量不能小于原始设备子通道数量。
URL
GET /v1?
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyDevice | 操作接口名,系统规定参数。 |
InProtocol | String | 是 | gb28181 | 使用的接入协议。取值:gb28181。 |
DeviceId | String | 是 | 32388909299 | 设备ID。 |
ParentDeviceId | String | 否 | 32387732995 | 上级设备ID,修改nvr通道信息时需要此参数。 |
DeviceType | String | 是 | nvr | 设备类型。取值: ipc, nvr。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个通道。 |
ChannelName | String | 否 | 通道1 | 修改子设备通道名称,长度为2-64位,可包含大小写字母、数字、中文、中划线、下划线、小括号、空格,不能以空格作为名称的首尾。自动创建的子设备不可修改通道名称。 |
SerialNumber | String | 否 | 123xxx | 设备SN码,长度不超过64位。 |
DeviceModel | String | 否 | 123xxx | 设备型号,长度不超过64位。 |
返回参数
参数 | 类型 | 描述 |
---|---|---|
DeviceId | String | 设备ID。 |
CreatedTime | String | 设备创建时间。 |
UpdatedTime | String | 设备更新时间。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=ModifyDevice&Description=xxx%E8%B7%AF%E5%8F%A3%E6%91%84%E5%83%8F%E5%A4%B4&DeviceId=581819016082440194&DeviceIp=192.168.0.1&DeviceName=xxx%E8%B7%AF%E5%8F%A3%E6%91%84%E5%83%8F%E5%A4%B4&DevicePort=8080&DeviceType=ipc&DeviceVendor=haikang&GbVersion=2016&InProtocol=gb28181&PullType=1&UserName=b12a6c3d
Connection: keep-alive
ctyun-eop-request-id: 321dbc70-737f-4409-9f46-f21c87f64668
Eop-date: 20221025T092425Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=/9Yp3pzFPkAgjxY/yAf0q3ocOSNQsjFTctK+1ZdDrdw=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"DeviceId": "581819016082440194",
"CreatedTime": "2022-10-25 09:24:23",
"UpdatedTime": "2022-10-25 09:24:25",
"RequestId": "45aa2bd59d2942869dd110817b82dd42"
}