You need to enable JavaScript to run this app.
导航
查看截图模板
最近更新时间:2022.02.08 14:18:34首次发布时间:2021.11.25 17:22:10

查询指定截图模板的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetScreenshotTemplate
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
TemplateIDQueryString模板 ID可通过调用 ListScreenshotTemplates 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数:

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

截图配置结构说明

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

Type

String[]

截图方式:

  • realtime(实时截图)

示例

请求示例

GET https://open.volcengineapi.com?Action=GetScreenshotTemplate
&Version=2021-01-01
&TemplateID=af991af9-fb07-4773-9ed1-c58e5b90a810
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112090950350102121620310C006FF6",
        "Action": "GetScreenshotTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "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"
    }
}