创建截图模板。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | CreateScreenshotTemplate |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2021-01-01 |
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
TemplateName | String | 是 | 模板名称,支持汉字、大小写字母、数字、中划线 |
Screenshot | Array of objects | 是 | 截图配置,参考以下 截图配置结构说明 |
截图配置结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
ScreenshotPeriod | Integer | 是 | 截图频率,单位毫秒 |
Type | String[] | 是 | 截图方式:
|
通用返回参数,请参考 ResponseMetadata 结构体说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
ID | String | 创建成功的截图模板 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" } }