CreateLiveSnapshotTemplate - 创建实时截图模板

调用CreateLiveSnapshotTemplate创建实时截图模板,模板便于创建截图任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:CreateLiveSnapshotTemplate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TemplateNamestring

模板名称。

  • 最大长度为 128。
模板1
OverwriteFormatstring

覆盖截图文件格式。

  • 不能以“/”开头,目前只支持.jpg 后缀。
  • 最大长度为 255。
  • 支持占位符: {JobId}:截图任务 ID
  • 不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符。
  • 覆盖截图和序列截图的文件格式至少要设置一个。
snapshot/{JobId}.jpg
SequenceFormatstring

序列截图文件格式。

  • 不能以“/”开头,目前只支持.jpg 后缀。
  • 最大长度为 255。
  • 支持占位符:{JobId}:截图任务 ID、{Date}:截图日期、{UnixTimestamp}:时间戳、{Sequence}:序列号,其中{UnixTimestamp}、{Sequence}至少要填写一个。
  • 覆盖截图和序列截图的文件格式至少要设置一个。
snapshot/{JobId}/{UnixTimestamp}.jpg
TimeIntervalinteger

截图时间间隔,单位:秒。

  • 取值范围是[5, 3600]。
5

返回参数

名称类型描述示例值
object

响应数据。

RequestIdstring

请求 ID。

******11-DB8D-4A9A-875B-275798******
TemplateIdstring

模板 ID。

****a046-263c-3560-978a-fb287782****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TemplateId": "****a046-263c-3560-978a-fb287782****"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter%s-
400InvalidParameter%s-
403UserDisableUser is disable.-
403ForbiddenUser not authorized to operate on the specified resource.无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。)
403OperationDeniedYour account has not enabled the ICE service.账号未开通智能媒体生产服务。
500InternalErrorThe request processing has failed due to some unknown error.后台发生未知错误,请稍后重试或联系客服解决。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史