功能介绍
默认接口请求频率限制:500次/秒。
修改组信息。
接口约束
修改组前确保组已存在。
URI
GET /v1?
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyVSSGroup | 操作接口名,系统规定参数。 |
GroupId | String | 是 | 208383238668288 | 组ID。 |
GroupName | String | 否 | openapi-update | 组名称,长度 4-64位,可包含大小写字母、数字、中文、中划线、下划线、小括号、空格,不能以空格作为名称的首尾。 |
Description | String | 否 | 视频监控 | 组描述,长度不超过255个字符。 |
AppName | String | 否 | vss | 组使用的应用名称,默认vss。 |
OutProtocol | String | 否 | rtmp | 组使用的播放协议,多值用逗号分隔。 取值: rtmp, hls, flv , webrtc |
PullType | Long | 否 | 1 | 是否启用自动拉流,默认1。可选项,仅gb28181, rtsp,Ehome组支持该字段,非gb28181, rtsp, Ehome组忽略该字段。取值:1, 2取值为1,自动拉流,平台自动启动拉流;取值为2,按需拉流,需要通过触发的方式启动拉流。 |
返回参数
参数 | 类型 | 描述 |
---|---|---|
GroupId | String | 组ID。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=ModifyVSSGroup&AppName=vss&Description=%E8%A7%86%E9%A2%91%E7%9B%91%E6%8E%A7&GroupId=581817787721793537&InProtocol=gb28181&OutProtocol=rtmp%2Chls%2Cflv%2Cwebrtc&PullType=1&Region=0851001
Connection: keep-alive
ctyun-eop-request-id: 1b41172b-560f-457f-8f81-adafa9eb9577
Eop-date: 20221025T092201Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=j87SnO8CDnwB+PcINuG+DnhVmjbyGfjMoznuPVNvUhs=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"GroupId": "581817787721793537",
"RequestId": "386b99677a12495885cd947d22deb4ce"
}