ListLiveSnapshotTemplates - 获取实时截图模板列表

更新时间:
复制 MD 格式

调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListLiveSnapshotTemplates

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SearchKeyWord

string

否

搜索关键词,模板 ID/名称,名称支持模糊搜索。

  • 最大长度为 128。

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

TemplateIds

array

否

指定模板 ID 查询。

  • 如果指定 SearchKeyWord,该条件不生效。

  • 数组长度最大为 200。

string

否

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

Type

string

否

模板类型,默认是查询全部。

枚举值:

  • system :

    系统预置

  • custom :

    自定义

custom

PageNo

integer

否

页码,[1, n),默认是 1。

1

PageSize

integer

否

页宽,[1, 100],默认是 10。

10

SortBy

string

否

排序,默认按 CreateTime 排序,默认是 desc。

枚举值:

  • asc :

    按 CreateTime 升序

  • desc :

    按 CreateTime 倒序

desc

返回参数

名称

类型

描述

示例值

object

响应数据。

RequestId

string

请求 ID。

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

TemplateList

array<object>

模板列表。

object

TemplateId

string

模板 ID。

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

TemplateName

string

模板名称。

Template 1

Type

string

模板类型。

枚举值:

  • system :

    系统预置

  • custom :

    自定义

custom

TimeInterval

integer

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

10

CreateTime

string

创建时间。

2022-07-20T02:48:58Z

PageNo

integer

页码。

1

PageSize

integer

页宽。

10

SortBy

string

排序。

desc

TotalCount

integer

总数。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TemplateList": [
    {
      "TemplateId": "****a046-263c-3560-978a-fb287782****",
      "TemplateName": "Template 1",
      "Type": "custom",
      "TimeInterval": 10,
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "SortBy": "desc",
  "TotalCount": 100
}

错误码

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 OperationDenied Your account has not enabled the ICE service.
403 Forbidden User not authorized to operate on the specified resource.

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

变更历史

更多信息,参考变更详情。