You need to enable JavaScript to run this app.
导航
添加固定回源配置
最近更新时间:2023.09.25 21:10:02首次发布时间:2023.05.09 11:41:58

本接口支持对域名空间下指定的 App 和 Stream 添加固定回源(含永久回源)配置。

说明

该接口属于历史版本的 API,我们我们计划于 2023 年 12 月 25 日停止对其进行维护,,并于 2024 年 3 月 25 日下线文档,建议您使用新版添加固定回源配置接口。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

StartTime

Integer

1683518058

开始时间,Unix 时间戳,单位为 s

说明

StartTimeEndTime 同时缺省,表示永久回源。

EndTime

Integer

1683777258

结束时间,Unix 时间戳,单位为 s,结束时间需晚于 StartTime,且与 StartTime 的最大时间跨度为 7 天。

说明

StartTimeEndTime 同时缺省,表示永久回源。

AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamStringstream-123流名称
DomainStringpush.example.com推流域名
SrcAddrSArray of String["rtmp://live.example.com"]回源地址列表,支持输入 RTMP、FLV 和 HLS 协议的直播地址。

返回参数

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

参数类型示例值描述
TaskIdString1612*******1固定回源的任务 ID

示例

请求示例

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

返回示例

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

错误码

访问公共错误码获取详细信息。