文档中心

更新固定回源配置

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

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

调用 UpdateRelaySourceV4 接口，更新固定回源配置。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
App	String	是	`live`	应用名称，即直播流地址的 `AppName` 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
Stream	String	是	`stream-123`	流名称，即直播流地址的 `StreamName` 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、字母、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
Domain	String	是	`push.example.com`	直播流使用的域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名。
SrcAddrS	Array of String	是	`["rtmp://live.example.com"]`	回源地址列表，支持 RTMP、FLV、HLS 和 SRT 回源协议。说明当源站使用了非默认端口时，支持在回源地址中以`域名:端口`或 `IP:端口`的形式配置端口。最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。
StartTime	Integer	否	`1683518058`	开始时间，Unix 时间戳，单位为秒。说明回源开始到结束最大时间跨度为 7 天；开始时间与结束时间同时缺省，表示永久回源。
EndTime	Integer	否	`1683777258`	结束时间，Unix 时间戳，单位为秒。说明回源开始到结束最大时间跨度为 7 天；开始时间与结束时间同时缺省，表示永久回源。

返回参数

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

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateRelaySourceV4",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

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

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