文档中心

视频直播

拉流回源

CreateRelaySourceV4 - 添加固定触发回源配置

调用 CreateRelaySourceV4 接口，添加固定触发回源配置。固定触发指无需等待观众请求观看直播，系统会按配置从源站拉取直播流。适用于需要提前拉流、减少观众开始播放时等待时间的场景。

使用说明

如果您需要进行回源鉴权配置，请通过创建工单联系技术支持获取。
固定触发回源配置包含固定回源和永久回源类型。
- 固定回源仅在指定回源时间内回源，因此需要传入回源开始时间 StartTime 和回源结束时间 EndTime。
- 永久回源会持续按配置回源，直到您手动删除回源配置。不传回源开始时间 StartTime 和回源结束时间 EndTime，即可添加永久回源类型的回源配置。

说明

如需添加永久回源类型的回源配置，请确保已开通永久回源功能。如未开通，请联系技术支持开通该功能。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`pull.example.com`	域名空间。通过以下任一方式，获取域名空间：调用 ListDomainDetail 接口，通过返回参数 `Vhost` 获取。在视频直播控制台的域名管理页面，通过域名空间字段获取。
App	String	是	`live`	视频直播播放地址中的 `AppName`。例如播放地址为 `rtmp://pull.example.com/live/test?authinfo`，则 `AppName` 为 `live`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明同一 `App` 不能同时配置播放触发和固定触发的回源配置。您可调用 DescribeRelaySourceV3 查询已有播放触发回源配置的 `App` 取值。
Stream	String	是	`example_stream`	视频直播播放地址中的 `StreamName`。例如播放地址为 `rtmp://pull.example.com/live/test?authinfo`，则 `StreamName` 为 `test`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）和短横线（-）组成，长度为 1 到 100 个字符。说明 `App` 和 `Stream` 的组合不能与已有固定触发回源配置重复。您可调用 ListRelaySourceV4 查询已有固定触发回源配置的 `App` 和 `Stream` 取值。
SrcAddrS	Array of String	是	`["rtmp://live.example.com/live01/test01"]`	回源地址列表，即视频直播从源站拉取直播流时访问的地址列表。支持 RTMP、RTMPS、FLV 或 HLS 协议。通常包含协议、源站的域名或 IP 地址，以及源站直播流的 `AppName` 和 `StreamName`。如果源站要求回源请求携带额外参数，还需包含查询参数。例如 `rtmp://192...10/live01/test01?token=abc`。说明支持配置自有源站或第三方源站的回源地址。触发回源后，视频直播会访问您配置的回源地址，从源站拉取直播流。如果源站使用非默认端口，需在源站的域名或 IP 地址后填写端口，例如 `rtmp://192...10:1936/live01/test01?token=abc`，否则系统可能按默认端口访问源站，导致回源失败。最多支持传入 10 个回源地址。系统会按照回源地址在数组中的排列顺序依次尝试回源，数组中越靠前的地址优先级越高。如果当前回源地址回源失败，系统会再尝试下一个回源地址。
StartTime	Integer	否	`1785923506`	回源开始时间。Unix 时间戳，单位为秒。说明 `StartTime` 和 `EndTime` 的时间间隔不可超过 7 天。 `StartTime` 和 `EndTime` 需同时传入或同时不传。传入时，表示添加固定回源类型的回源配置。不传时，表示添加永久回源类型的回源配置。
EndTime	Integer	否	`1785953506`	回源结束时间。Unix 时间戳，单位为秒。说明 `StartTime` 和 `EndTime` 的时间间隔不可超过 7 天。 `StartTime` 和 `EndTime` 需同时传入或同时不传。传入时，表示添加固定回源类型的回源配置。不传时，表示添加永久回源类型的回源配置。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`1612*******1`	固定触发回源配置的 ID。

请求示例

POST https://live.volcengineapi.com?Action=CreateRelaySourceV4&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": "CreateRelaySourceV4",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "1612*******1"
    }
}

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.Format	-	输入的参数无效或格式不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.OutOfRange	-	输入的参数无效或取值范围不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllowed	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429	RequestLimitExceeded	-	请求创建的资源已经超过限定数额。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

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

最近更新时间：2026.08.24 19:09:22

这个页面对您有帮助吗？

有用

无用

视频直播

使用说明 #

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

服务端 SDK #