You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播时移配置列表

最近更新时间：2023.09.25 21:09:59

首次发布时间：2022.04.19 20:40:35

我的收藏

根据域名查询指定应用绑定的时移模板列表。

说明

该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询直播时移配置列表接口。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString否live.example.com域名空间名称

Type

String

否

tos

时移类型。默认类型为 VoD。

  • vod：点播时移，获取 vod 类型的时移模板配置信息；
  • tos：直播时移，获取 tos 以及 fcdn-tos 类型的时移模板配置信息。

返回参数

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

参数类型示例值描述
ListArray of List-模板列表

List

参数类型示例值描述
VhostStringlive.example.com域名空间名称
AppStringlive应用名称
MaxShiftTimeInteger25920最大时移时长，即观看时移的最长时间，单位为 s
VODNamespaceStringnamaspace点播空间
DomainStringpull.example.com拉流域名

Status

Integer

1

直播时移配置模版状态。

  • 0：配置中；
  • 1：已启用。
StreamStringstream-123流名称
NameStringlivedemo模板名称
BucketString5cd18a3563**********cbe0aaf694ToS 存储目录

Type

String

fcdn-tos

类型。默认类型为 VoD。

  • VoD
  • ToS
  • fcdn-ToS

示例

请求示例

POST https://live.volcengineapi.com?Action=ListTimeShiftPresetV2&Version=2020-08-01
{
  "Vhost": "live.example.net",
  "Type": "vod"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ListTimeShiftPresetV2",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1",
    "Result": {
      "List": [
        {
          "App": "live",
          "Bucket": "5cd18a3563**********cbe0aaf694",
          "Domain": "pull.example.com",
          "MaxShiftTime": 259200,
          "Name": "livedemo",
          "Status": 1,
          "Stream": "stream-123",
          "Type": "fcdn-tos",
          "UpdateTime": "2023-07-10 01:58:27",
          "VODNamespace": "",
          "Vhost": "live.example.com"
        }
      ]
    }
  }
}

错误码

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