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

查询截图配置列表

最近更新时间：2024.04.08 14:10:10

首次发布时间：2024.01.25 17:10:14

我的收藏

调用 ListVhostSnapshotPresetV2 接口，查询截图配置列表。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

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

Type

String

否

tos

截图配置中截图文件的存储位置，缺省情况下表示不对存储位置进行过滤，取值及含义如下所示。

  • tos：TOS 对象存储服务；
  • imageX：veImageX 图片服务。

返回参数

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

参数类型示例值描述
PresetListArray of PresetList-截图配置列表。

PresetList

参数类型示例值描述
VhostStringpush.example.com域名空间名称。
AppStringlive应用名称。
SlicePresetV2Object of SlicePresetV2-截图配置基础信息。

SlicePresetV2

参数类型示例值描述
SnapshotPresetConfigObject of SnapshotPresetConfig-截图配置详细信息。
NameStringpreset-123截图配置名称。

Status

Integer

1

截图配置生效状态。

  • 1：生效；
  • 0：不生效。

SnapshotPresetConfig

参数类型示例值描述
JpegParamObject of CDNSnapshotParam-图片格式为 JPEG 时的截图参数。
JpgParamObject of CDNSnapshotParam-截图格式为 JPG 时的截图参数。
IntervalInteger10截图间隔时间，单位为秒。

CDNSnapshotParam

参数类型示例值描述

Enable

Boolean

true

当前格式的截图是否开启，默认为 false，取值及含义如下所示。

  • false：不开启；
  • true：开启。

TOSParam

Object of TOSParam

-

截图存储到 TOS 时的配置。

说明

TOSParam 和 ImageXParam 配置且配置其中一个。

ImageXParam

Object of ImageXParam

-

截图存储到 veImageX 时的配置。

说明

TOSParam 和 ImageXParam 配置且配置其中一个。

TOSParam

参数类型示例值描述

Enable

Boolean

true

截图是否使用 TOS 存储，取值及含义如下所示。

  • false：不使用；
  • true：使用。

Bucket

String

live-test-tos-example

TOS 存储对应的 Bucket。
例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。

StorageDir

String

live/liveapp

Bucket 目录。
例如，存储路径为 live-test-tos-example/live/liveapp 时，StorageDir 取值为 live/liveapp。

ExactObjectString{Domain}/{App}/{Stream}/{UnixTimestamp}存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
OverwriteObjectString{Domain}/{App}/{Stream}存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。

ImageXParam

参数类型示例值描述

Enable

Boolean

true

截图是否使用 veImageX 存储，取值及含义如下所示。

  • false：不使用；
  • true：使用。
ServiceIDStringWMK***UX使用 veImageX 存储截图时，对应的 veImageX 的服务 ID。
OverwriteObjectString{Domain}/{App}/{Stream}存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
ExactObjectString{Domain}/{App}/{Stream}/{UnixTimestamp}存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。

请求示例

POST https://live.volcengineapi.com?Action=ListVhostSnapshotPresetV2&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "Type": "tos"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListVhostSnapshotPresetV2",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "PresetList": [
            {
                "Vhost": "push.example.com",
                "App": "live",
                "SlicePreset": {
                    "SnapshotPresetConfig": {
                        "JpegParam": {
                            "Enable": true,
                            "TOSParam": {
                                "Enable": true,
                                "Bucket": "live-test-tos-example",
                                "StorageDir": "live/liveapp",
                                "ExactObject": "{Domain}/{App}/{Stream}/{UnixTimestamp}"
                            }
                        },
                        "Interval": 10
                    },
                    "Name": "preset-123",
                    "Status": "1"
                }
            }
        ]
    }
}

错误码

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

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