创建截图模板。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | CreateScreenshotTemplate | 接口名称。当前 API 的名称为 CreateScreenshotTemplate。 |
| Version | String | 是 | 2021-01-01 | 接口版本。当前 API 的版本为 2021-01-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| TemplateName | String | 是 | | 模板名称，支持汉字、大小写字母、数字、中划线 |
| Screenshot | Object of Screenshot | 是 | | 截图配置，参考以下 截图配置结构说明 |
Screenshot
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| ScreenshotPeriod | Integer | 是 | | 截图周期，单位ms，大于10秒，小于3分钟。 |
| Type | Array of String | 是 | | 模板类型，realtime/lowfrequency。 |
| TTL | Object of TTL | 否 | | TTL |
| EnableTimes | Array of EnableTimes | 否 | | |
TTL
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Days | Integer | 否 | | 存储天数。 |
EnableTimes
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| WeekDay | Integer | 是 | 1 | 星期几。 |
| EnableFrom | String | 是 | | 启用开始时间。 |
| EnableTo | String | 是 | | 启用结束时间。 |
| Enable | Boolean | 是 | true | 是否启用。 |
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|
| ID | String | | 创建成功的截图模板 ID |
请求示例
POST https://open.volcengineapi.com
{
"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"
}
}
错误码
您可访问公共错误码，获取更多错误码信息。