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

查询截图配置列表

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

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

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

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

返回示例

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

错误码

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

状态码错误码错误信息说明
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.内部服务超时，请联系技术支持。