修改设备
最近更新时间:2025-02-21 02:50:53
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制:500次/秒。
修改RTSP设备。
2. 请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyDevice | 操作接口名,系统规定参数。 |
InProtocol | String | 是 | rtsp | 使用的接入协议。 取值: rtsp |
InType | Long | 否 | pull | 视频流接入方式。 取值: push, pull 取值为push,推流; 取值为pull,拉流。 |
DeviceId | String | 是 | 32388483999 | 设备ID。 |
DeviceVendor | String | 否 | haikang | 设备厂商。 |
DeviceName | String | 否 | xx | 设备名称。 |
Description | String | 否 | xx | 设备描述。 |
DeviceIp | String | 否 | 192.168.0.1 | 设备Ip。 |
DevicePort | Long | 否 | 554 | 设备Port。 |
PullType | Long | 否 | 1 | 是否启用自动拉流, InType设置为1,该字段才有效 。 默认继承组PullType,但如果设置了该字段,则会覆盖组下面的PullType值。 取值:1, 2。默认为1。 取值为1,自动拉流,设备创建成功后,平台自动启动拉流; 取值为2,按需拉流,需要通过触发的方式启动拉流。 |
PushType | Long | 否 | 1 | 是否启用自动激活推流地址,InType设置为2,该字段才有效。 默认继承组PushType,但如果设置了该字段,则会覆盖组下面的PushType值。 取值:1, 2。默认为1。 取值为1,自动激活推流地址,设备创建完成后,平台立刻自动生成推流地址; 取值为2,按需推流,需要通过触发的方式生成推流地址。 |
PullUrl | String | 否 | rtsp://admin:admin@192.168.0.1:554/Streaming/Channels/102 | 拉流地址。 如果InType设置为1,该字段才有效。 |
TransPriority | String | 否 | tcp | 设备视频流优先传输协议,默认tcp。 取值:tcp, udp。 取值为tcp,如果设备支持tcp协议传输,设备进行视频邀约时优先使用tcp协议接入到vss服务中。 取值为udp,设备进行视频邀约时优先使用udp协议接入到vss服务中。 |
3. 返回参数
参数 | 类型 | 描述 |
---|---|---|
DeviceId | String | 平台ID。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4.1 请求示例
https://vssapi.ctyun.cn/
?Action=ModifyDevice
&InProtocol=rtsp
&InType=pull
&DeviceId=32388483999
&DeviceVendor=haikang
&DeviceName=test-platform
&Description=test-rtsp
&DeviceIp=192.168.0.1
&DevicePort=554
&PullType=1
&PushType=1
&PullUrl=rtsp://admin:admin@192.168.0.1:554/Streaming/Channels/102
&TransPriority=tcp
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=%2FUKPWN9c6i1aUftJGt1OgUTqjck%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1262606746
&SignatureVersion=1.0
&Timestamp=1599108325
4.2 返回示例
{
"DeviceId": "29942028422873997",
"RequestId": "1ad5d74c191949e7b09500f80f688ef0"
}
5. 错误码
ErrorCode | ErrorMessage |
---|---|
本页目录: