You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/拉流回源/添加固定回源配置
添加固定回源配置
最近更新时间：2024.05.10 16:59:16首次发布时间：2023.09.25 14:34:05
我的收藏

调用 CreateRelaySourceV4 接口，添加固定触发回源配置，固定触发指根据您设置的回源时间定时从源服务器拉取直播流数据，不论是否有观众观看；这种方式可以确保 CDN 节点始终拥有最新的直播流数据，降低观众在观看时的等待时间，提高观看体验。

使用说明

如果您需要进行回源鉴权配置，请通过创建工单联系技术支持获取。

注意事项

  • 生效时间：配置自有源站或第三方源站回源地址，视频直播将通过 AppName 与源站推流 AppName 匹配后进行拉流，配置完成后约 3-5 分钟生效。
  • 请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

调试

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainString是pull.example.com拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的拉流域名。
AppString是live应用名称，即直播流地址的 AppName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
StreamString是example_stream流名称，即直播流地址的 StreamName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、字母、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。

SrcAddrS

Array of String

是

["rtmp://live.example.com"]

回源地址列表，支持输入 RTMP、FLV、HLS 和 SRT 协议的直播推流地址。

说明

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

StartTime

Integer

否

1683518058

回源开始时间，Unix 时间戳，单位为秒。

说明

  • 回源开始到结束最大时间跨度为 7 天；
  • 开始时间与结束时间同时缺省，表示永久回源。

EndTime

Integer

否

1683777258

回源结束时间，Unix 时间戳，单位为秒。

说明

  • 回源开始到结束最大时间跨度为 7 天；
  • 开始时间与结束时间同时缺省，表示永久回源。

返回参数

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

参数类型示例值描述
TaskIdString1612*******1固定回源配置的 ID。

请求示例

POST https://live.volcengineapi.com?Action=CreateRelaySourceV4&Version=2023-01-01
{
  "App": "live",
  "Stream": "example_stream",
  "SrcAddrS": [
    "rtmp://live.example.com"
  ],
  "Domain": "pull.example.com",
  "StartTime": "1683518058",
  "EndTime": "1683777258"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"CreateRelaySourceV4",
        "Version":"2023-01-01",
        "Service":"live",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "1612*******1"
    }
}

错误码

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

状态码错误码错误信息说明
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-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error 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。