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

查询截图配置列表

最近更新时间：2023.10.12 17:39:58

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

我的收藏

查询域名维度下所有的 App 名称，以及 App 关联的截图模板。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

Type

String

否

tos

截图存储类型。

  • tos；
  • imageX。
VhostString是push.example.com域名空间名称

返回参数

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

参数类型示例值描述
PresetListArray of PresetList-模版列表

PresetList

参数类型示例值描述
VhostStringpush.example.com域名空间名称
AppStringlive应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
SlicePresetObject of SlicePreset-截图模板名称

SlicePreset

参数类型示例值描述
PresetStringpreset-123截图模版名称

Status

Integer

1

截图模版状态。

  • 1：开启
  • 0：关闭
IntervalInteger3截图间隔时间
BucketStringlive-test-tos-example截图在 ToS 中的存储位置
CallbackDetailArray of CallbackDetail-回调信息
ServiceIDStringWMK***UXveImageX 的服务 ID

CallbackDetail

参数类型示例值描述

CallbackType

String

http

回调类型。

  • http
  • nsq
  • kafka
  • rpc
URLStringhttps://example/api/callback回调地址

示例

请求示例

POST https://live.volcengineapi.com?Action=ListVhostSnapshotPreset&Version=2020-08-01
{
  "Vhost": "push.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ListVhostSnapshotPreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "PresetList": [
      {
        "Vhost": "push.example.com",
        "App": "live",
        "SlicePreset": {
          "Preset": "preset-123",
          "Status": 1,
          "Interval": 3,
          "Bucket": "live-test-tos-example",
          "CallbackDetail": [],
          "ServiceID": ""
        }
      }
    ]
  }
}

错误码

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