You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询播放触发回源配置

最近更新时间：2023.10.12 17:39:58

首次发布时间：2022.04.19 20:40:35

我的收藏

本接口支持根据 Vhost 信息，查询对应的播放触发的拉流回源配置信息。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询播放触发回源配置接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribeRelaySourceV3&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是DescribeRelaySourceV3接口名称。当前 API 的名称为 DescribeRelaySourceV3。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称
AppString否liveApp名称
GroupString否relay1组名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
RelaySourceConfigListArray of RelaySourceConfigList-回源配置列表

RelaySourceConfigList

参数类型示例值描述
VhostStringpush.example.com域名空间名称
AppStringliveApp名称
GroupDetailsArray of GroupDetails-回源组配置详情

GroupDetails

参数类型示例值描述
GroupStringrelay1回源组名称
ServersArray of Servers-回源服务器配置列表

Servers

参数类型示例值描述
RelaySourceDomainStringrtmp回源地址
RelaySourceProtocolStringexample.org回源协议

RelaySourceParams

JSON Map

{
	"key1":	"value1",
	"key2": "value2"
}

自定义回源参数

示例

请求示例

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"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。