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

添加或更新播放触发回源配置

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

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

我的收藏

添加回源配置。本接口支持在指定应用名称后，选择相应的回源协议和回源地址，添加新的拉流回源配置。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称
AppString是live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
GroupDetailsArray of GroupDetails是-回源组配置详情

GroupDetails

参数类型是否必选示例值描述
GroupString是relay1回源组名称
ServersArray of Servers是-回源服务器配置列表

Servers

参数类型是否必选示例值描述
RelaySourceDomainString是example.org回源地址

RelaySourceProtocol

String

是

rtmp

回源协议，支持两种回源协议。

  • rtmp
  • flv
RelaySourceParamsJSON Map否{"key1": "value1","key2": "value2"}自定义回源参数，缺省情况下为空。格式为 "Key":"Value"，例如，"domain":"live.push.net",

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://live.volcengineapi.com?Action=UpdateRelaySourceV3&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "GroupDetails": [
    {
      "Group": "relay1",
      "Servers": [
        {
          "RelaySourceProtocol": "rtmp",
          "RelaySourceDomain": "example.org",
          "RelaySourceParams": {
            "key1": "value1",
            "key2": "value2"
          }
        }
      ]
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "Service": "live",
    "Region": "cn-north-1",
    "Version": "2020-08-01",
    "Action": "UpdateRelaySourceV3",
    "RequestId": "202306041104200100100232280022D31"
  }
}

错误码

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