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

创建截图模板。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段
类型
必填
说明
TemplateNameString模板名称,支持汉字、大小写字母、数字、中划线
ScreenshotArray of objects截图配置,参考以下 截图配置结构说明

截图配置结构说明

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

Type

String[]

截图方式:

  • realtime(实时截图,每张截图文件都独立存储,不覆盖)

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
IDString创建成功的截图模板 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateScreenshotTemplate
&Version=2021-01-01
&<公共请求参数>
{
    "TemplateName": "screenshot-template-01",
    "Screenshot": {
        "ScreenshotPeriod": 10000,
        "Type": [
                 "realtime"
                ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081952480102040490790900178D",
        "Action": "CreateScreenshotTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "cc0c4bb7-7274-43a4-9aea-45dcb9f5c2d7"
    }
}