修改设备

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

1. 接口描述

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

修改RTMP设备。

2. 请求参数

参数类型是否必选示例值描述
ActionStringModifyDevice操作接口名,系统规定参数。
InProtocolStringrtmp使用的接入协议。
取值: rtmp
InTypeLongpush视频流接入方式。
取值: push, pull
取值为push,推流;
取值为pull,拉流。
DeviceIdString32388483999设备ID。
DeviceVendorStringhaikang设备厂商。
DeviceNameStringxx设备名称。
DescriptionStringxx设备描述。
PullTypeLong1是否启用自动拉流, InType设置为pull,该字段才有效 。
默认继承组PullType,但如果设置了该字段,则会覆盖组下面的PullType值。
取值:1, 2。默认为1。
取值为1,自动拉流,设备创建成功后,平台自动启动拉流;
取值为2,按需拉流,需要通过触发的方式启动拉流。
PushTypeLong1是否启用自动激活推流地址,InType设置为push,该字段才有效。
默认继承组PushType,但如果设置了该字段,则会覆盖组下面的PushType值。
取值:1, 2。默认为1。
取值为1,自动激活推流地址,设备创建完成后,平台立刻自动生成推流地址;
取值为2,按需推流,需要通过触发的方式生成推流地址。
PullUrlStringrtmp://192.168.0.1:1935/live/101拉流地址。
如果InType设置为pull,该字段才有效。
TagsStringkey1:value1,key2:value2和视频流关联的标签。
一个视频流最多添加10个标签。

3. 返回参数

参数类型描述
DeviceIdString平台ID。
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=ModifyDevice
&InProtocol=rtmp
&InType=push
&DeviceId=32388483999
&DeviceVendor=haikang
&DeviceName=haikang
&Description=test-platform
&PullType=1
&PushType=1
&PullUrl=rtmp://192.168.0.1:1935/live/101
&Tags=key1:value1,key2:value2
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=%2FUKPWN9c6i1aUftJGt1OgUTqjck%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1262606746
&SignatureVersion=1.0
&Timestamp=1599108325

4.2 返回示例

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

5. 错误码

ErrorCodeErrorMessage