You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播时移配置列表

最近更新时间：2023.10.23 16:14:02

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

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListTimeShiftPresetV2接口名称。当前 API 的名称为 ListTimeShiftPresetV2。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-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=2023-01-01
{
  "Vhost": "live.example.net",
  "Type": "vod"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ListTimeShiftPresetV2",
    "Version": "2023-01-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"
        }
      ]
    }
  }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。