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

查看截图模板列表

最近更新时间：2022.02.08 14:18:34

首次发布时间：2021.11.25 17:27:22

我的收藏

查询已创建的截图模板列表。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称ListScreenshotTemplates
VersionQueryString是公共参数，OpenAPI 接口版本2021-01-01

Order

Query

Integer

否

查询结果排序方式

可选枚举值：

  • 1（正序）
  • -1（倒序，默认）

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段
类型
说明
TemplatesArray of objects查询到的截图模板列表，参考以下 List<Templates> 结构说明

List<Templates> 结构说明

字段
类型
说明
TemplateNameString模板名称
TemplateIDString模板 ID
TemplateTypeString模板类型
CreatedAtString模板创建时间
UpdatedAtString模板更新时间
ScreenshotArray of objects截图配置，参考以下 截图配置结构说明

截图配置结构说明

字段
类型
说明
ScreenshotPeriodInteger截图频率，单位毫秒

Type

String

截图方式：

  • realtime（实时截图）

示例

请求示例

GET https://open.volcengineapi.com?Action=ListScreenshotTemplates
&Version=2021-01-01
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081911270102121360471C0009C5",
        "Action": "ListScreenshotTemplates",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "Templates": [
            {
                "TemplateID": "a66eed7a-57a4-46c1-bb87-8fabb68fa951",
                "TemplateName": "online-snapshot-1022-bj",
                "TemplateType": "screenshot",
                "Screenshot": {
                    "ScreenshotPeriod": 10000,
                    "Type": [
                        "realtime"
                    ]
                },
                "CreatedAt": "2021-10-22T14:11:07+08:00",
                "UpdatedAt": "2021-12-01T11:11:15+08:00"
            },
            {
                "TemplateID": "af991af9-fb07-4773-9ed1-c58e5b90a810",
                "TemplateName": "hyzsnap01",
                "TemplateType": "screenshot",
                "Screenshot": {
                    "ScreenshotPeriod": 20000,
                    "Type": [
                        "realtime"
                    ]
                },
                "CreatedAt": "2021-11-01T16:12:46+08:00",
                "UpdatedAt": "2021-12-01T11:12:02+08:00"
            }
        ]
    }
}