You need to enable JavaScript to run this app.
文档中心
视频直播

视频直播

复制全文
下载 pdf
拉流回源
UpdateRelaySourceV4 - 更新固定触发回源配置
复制全文
下载 pdf
UpdateRelaySourceV4 - 更新固定触发回源配置

调用 UpdateRelaySourceV4 接口,更新指定固定触发回源配置。

使用说明

固定触发回源配置包含固定回源和永久回源类型。您可以调用该接口,更新回源配置的回源地址、回源时间或回源类型。

  • 固定回源仅在指定回源时间内回源,因此需要传入回源开始时间 StartTime 和回源结束时间 EndTime
  • 永久回源会持续按配置回源,直到您手动删除回源配置。不传回源开始时间 StartTime 和回源结束时间 EndTime,即可更新为永久回源类型。

说明

如需将固定回源类型变更为永久回源类型,确保已开通永久回源功能。如未开通,请联系技术支持开通该功能。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 生效时间:完成回源配置后,约 3-5 分钟生效。

请求说明

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

调试

请求参数

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

Query

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

Body

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

Vhost

String

pull.example.com

域名空间。
通过以下任一方式,获取域名空间:

  • 调用 ListDomainDetail 接口,通过返回参数 Vhost 获取。
  • 在视频直播控制台的域名管理页面,通过域名空间字段获取。
AppStringlive视频直播播放地址中的 AppName。您可调用 ListRelaySourceV4 并根据返回参数 App 获取固定触发回源配置的 AppName
StreamStringexample_stream视频直播播放地址中的 StreamName。您可调用 ListRelaySourceV4 并根据返回参数 Stream 获取固定触发回源配置的 StreamName

SrcAddrS

Array of String

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

回源地址列表,即视频直播从源站拉取直播流时访问的地址列表。支持 RTMP、RTMPS、FLV 或 HLS 协议。
通常包含协议、源站的域名或 IP 地址,以及源站直播流的 AppNameStreamName。如果源站要求回源请求携带额外参数,还需包含查询参数。例如 rtmp://192.*.*.10/live01/test01?token=abc

说明

  • 支持配置自有源站或第三方源站的回源地址。触发回源后,视频直播会访问您配置的回源地址,从源站拉取直播流。
  • 如果源站使用非默认端口,需在源站的域名或 IP 地址后填写端口,例如 rtmp://192.*.*.10:1936/live01/test01?token=abc,否则系统可能按默认端口访问源站,导致回源失败。
  • 最多支持传入 10 个回源地址。系统会按照回源地址在数组中的排列顺序依次尝试回源,数组中越靠前的地址优先级越高。如果当前回源地址回源失败,系统会再尝试下一个回源地址。

StartTime

Integer

1785923506

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

说明

  • StartTimeEndTime 的时间间隔不可超过 7 天。
  • StartTimeEndTime 需同时传入或同时不传。传入时,表示更新固定回源类型的回源时间,或将永久回源类型变更为固定回源类型并设置回源时间。不传时,表示更新为永久回源类型。

EndTime

Integer

1785953506

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

说明

  • StartTimeEndTime 的时间间隔不可超过 7 天。
  • StartTimeEndTime 需同时传入或同时不传。传入时,表示更新固定回源类型的回源时间,或将永久回源类型变更为固定回源类型并设置回源时间。不传时,表示更新为永久回源类型。

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=UpdateRelaySourceV4&Version=2023-01-01
{
    "Vhost": "pull.example.com",
    "App": "live",
    "Stream": "example_stream",
    "SrcAddrS": [
        "rtmp://live.example.com/live01/test01"
    ],
    "StartTime": 1785923506,
    "EndTime": 1785953506
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateRelaySourceV4",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围,请检查错误消息中指定参数的取值是否超出取值范围。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowedthis 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。

最近更新时间:2026.08.24 19:09:22
这个页面对您有帮助吗?
有用
有用
无用
无用