最近更新时间：2023.09.25 21:09:58
首次发布时间：2022.04.19 20:40:35
本接口支持根据 Vhost 信息，查询对应的播放触发的拉流回源配置信息。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询播放触发回源配置接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeRelaySourceV3 | 接口名称。当前 API 的名称为 DescribeRelaySourceV3。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Vhost | String | 是 | push.example.com | 域名空间名称 |
| App | String | 否 | live | App名称 |
| Group | String | 否 | relay1 | 组名称 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RelaySourceConfigList | Array of RelaySourceConfigList | - | 回源配置列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 域名空间名称 |
| App | String | live | App名称 |
| GroupDetails | Array of GroupDetails | - | 回源组配置详情 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Group | String | relay1 | 回源组名称 |
| Servers | Array of Servers | - | 回源服务器配置列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RelaySourceDomain | String | rtmp | 回源地址 |
| RelaySourceProtocol | String | example.org | 回源协议 |
RelaySourceParams | JSON Map |
| 自定义回源参数 |
POST https://live.volcengineapi.com?Action=DescribeRelaySourceV3&Version=2020-08-01 { "Vhost": "push.example.com", "App": "live" }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeRelaySource", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "RelaySourceConfigList": [ { "Vhost": "push.example.com", "App": "live", "GroupDetails": [ { "Group": "relay1", "Servers": [ { "RelaySourceProtocol": "rtmp", "RelaySourceDomain": "example.org", "RelaySourceParams": { "key1": "value1", "key2": "value2" } } ] } ] } ] } }
访问公共错误码获取详细信息。