CreateLiveSnapshotTemplate - 创建实时截图模板

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:CreateLiveSnapshotTemplate

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TemplateName

string

模板名称。

  • 最大长度为 128。

Template 1

OverwriteFormat

string

覆盖截图文件格式。

  • 不能以“/”开头,目前只支持.jpg 后缀。

  • 最大长度为 255。

  • 支持占位符: {JobId}:截图任务 ID

  • 不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符。

  • 覆盖截图和序列截图的文件格式至少要设置一个。

snapshot/{JobId}.jpg

SequenceFormat

string

序列截图文件格式。

  • 不能以“/”开头,目前只支持.jpg 后缀。

  • 最大长度为 255。

  • 支持占位符:{JobId}:截图任务 ID、{Date}:截图日期、{UnixTimestamp}:时间戳、{Sequence}:序列号,其中{UnixTimestamp}、{Sequence}至少要填写一个。

  • 覆盖截图和序列截图的文件格式至少要设置一个。

snapshot/{JobId}/{UnixTimestamp}.jpg

TimeInterval

integer

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

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

5

返回参数

名称

类型

描述

示例值

object

响应数据。

RequestId

string

请求 ID。

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

TemplateId

string

模板 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 MissingParameter %s
400 InvalidParameter %s
500 InternalError The request processing has failed due to some unknown error.
403 UserDisable User is disable.
403 Forbidden User not authorized to operate on the specified resource.
403 OperationDenied Your account has not enabled the ICE service.

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

变更历史

更多信息,参考变更详情