1. 接口描述

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

修改设备信息。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ModifyDevice	操作接口名，系统规定参数。
InProtocol	String	是	gb28181	使用的接入协议。取值: gb28181
DeviceId	String	是	32388909299	设备ID。
ParentDeviceId	String	否	32387732995	上级设备ID，修改nvr通道信息时需要此参数。
DeviceType	String	是	nvr	设备类型。取值: ipc, nvr, platform
GbVersion	String	否	2016	国标版本。取值: 2011, 2016 仅ipc设备和nvr设备需要此参数
DeviceVendor	String	否	haikang	设备厂商，长度不超过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位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。
MultiStreamSize	Long	否	1	主子码流数量，默认为1。取值: 1: 单码流（仅有一种码流） 2: 双码流（主、子码流） 3: 三码流（主、子、第三码流）
AutoStreamNum		否	2	自动拉取第几个码流。 PullType取值为1，该字段为必选项。取值: 1: 主码流 2: 子码流 3: 第三码流
SerialNumber	String	否	123xxx	设备SN码，长度不超过64位。
DeviceModel	String	否	123xxx	设备型号，长度不超过64位。

3. 返回参数

参数	类型	描述
DeviceId	String	设备ID。
CreatedTime	String	设备创建时间。
UpdatedTime	String	设备更新时间。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=ModifyDevice
&InProtocol=gb28181
&DeviceId=29942103584801365
&GbVersion=2011
&PullType=2
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=rK5fxAEXrEG%2F5QIdOJaQFecI6YQ%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1271981179
&SignatureVersion=1.0
&Timestamp=1599041654

4.2 返回示例

{
  "DeviceId": "29942103584801365",
  "CreatedTime": "2020-09-02 18:14:21",
  "UpdatedTime": "2020-09-02 18:14:21",
  "RequestId": "54f16ca8af284be093a8976cf9e102dc"
}

5. 错误码

ErrorCode	ErrorMessage

修改设备

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

1. 接口描述

2. 请求参数

3. 返回参数

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码