You need to enable JavaScript to run this app.
导航
查询固定回源配置列表
最近更新时间:2023.10.12 17:39:59首次发布时间:2023.05.09 11:41:58

本接口支持查询域名空间的固定回源(含永久回源)配置列表。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainStringpush.example.com推流域名
PageInteger1页码,默认值为 1,取值范围为正整数
SizeInteger20每页数量,取值范围为 [1,500],默认值为 20

返回参数

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

参数类型示例值描述
ListArray of List-配置列表
PaginationObject of Pagination-页码信息

List

参数类型示例值描述
DomainStringpush.example.com推流域名
AppStringlive应用名称
StreamStringstream-123流名称
StartTimeInteger683518058开始时间,StartTimeEndTime 同时缺省的情况下,表示永久回源
EndTimeInteger1683777258结束时间,StartTimeEndTime 同时缺省的情况下,表示永久回源
SrcAddrSArray of String["rtmp://push.example.com/live/callback"]回源地址列表

Pagination

参数类型示例值描述
PageCurInteger1当前页码
PageSizeInteger1单页数据量
PageTotalInteger1总页数
TotalCountInteger1总数据量

示例

请求示例

POST https://live.volcengineapi.com?Action=ListRelaySourceV4&Version=2020-08-01
{
    "App": "live",
    "Page": 1,
    "Size": 20
}

返回示例

{
    "ResponseMetadata": {
        "Version": "2020-08-01",
        "Region": "cn-north-1",
        "Action": "ListRelaySourceV4",
        "RequestId": "201806041104200100100232280022D30",
        "Service": "live"
    },
    "Result": {
        "Pagination": {
            "TotalCount": "1",
            "PageSize": "1",
            "PageTotal": "1",
            "PageCur": "1"
        },
        "List": [
            {
                "App": "live",
                "Domain": "push.example.com",
                "Stream": "stream-123",
                "StartTime": 1683518058,
                "SrcAddrS": [
                    "rtmp://push.example.com/live/callback"
                ],
                "EndTime": 1683777258
            }
        ]
    }
}

错误码

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