最近更新时间：2023.09.25 21:09:59
首次发布时间：2022.04.19 20:40:35
查询域名维度下所有的 App 名称，以及 App 关联的截图模板。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询截图配置列表接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListVhostSnapshotPreset | 接口名称。当前 API 的名称为 ListVhostSnapshotPreset。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Type | String | 否 |
| 截图存储类型。
|
| Vhost | String | 是 | push.example.com | 域名空间名称 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PresetList | Array of PresetList | - | 模版列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 域名空间名称 |
| App | String | live | 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
| SlicePreset | Object of SlicePreset | - | 截图模板名称 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Preset | String | preset-123 | 截图模版名称 |
Status | Integer |
| 截图模版状态。
|
| Interval | Integer | 3 | 截图间隔时间 |
| Bucket | String | live-test-tos-example | 截图在 ToS 中的存储位置 |
| CallbackDetail | Array of CallbackDetail | - | 回调信息 |
| ServiceID | String | WMK***UX | veImageX 的服务 ID |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
CallbackType | String |
| 回调类型。
|
| URL | String | https://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": "" } } ] } }
访问公共错误码获取详细信息。