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

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

最近更新时间：2024.03.14 17:07:57

首次发布时间：2023.09.25 14:34:05

我的收藏

调用 UpdateRelaySourceV3 接口，添加或更新播放触发回源配置。

使用说明

  • 配置自有源站或第三方源站回源地址，视频直播将通过 AppName 与源站推流 AppName 匹配后进行拉流，配置完成后约 3-5 分钟生效。
  • 播放触发指回源操作仅在有观众观看时才会触发，可以节省源服务器的带宽资源，提高系统的整体效率。
  • 如果您需要获取更多鉴权配置，请通过创建工单联系技术支持获取。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名所属的域名空间。
AppString否live应用名称，即直播流地址的 AppName 字段取值，默认为空，表示为当前域名空间的全局播放触发回源配置。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
GroupDetailsArray of GroupDetails是-回源组配置详情。

GroupDetails

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

Servers

参数类型是否必选示例值描述

RelaySourceDomain

String

是

example.org

直播源服务器的地址，支持填写回源服务的域名或 IP 地址。

说明

  • 当源站使用了非默认端口时，支持在回源地址中以域名:端口或 IP:端口的形式配置端口。
  • 最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。

RelaySourceProtocol

String

是

rtmp

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

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

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=UpdateRelaySourceV3&Version=2023-01-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": "2023-01-01",
        "Action": "UpdateRelaySourceV3_1h0pbmhmb",
        "RequestId": "202306041104200100100232280022D31"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429RequestLimitExceeded.Exist%s already exist请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。