文档

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

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

  • 最大长度为 128。
****a046-263c-3560-978a-fb287782****
TemplateIdsarray

指定模板 ID 查询。

  • 如果指定 SearchKeyWord,该条件不生效。
  • 数组长度最大为 200。
string
****a046-263c-3560-978a-fb287782****
Typestring

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

枚举值:
  • system系统预置
  • custom自定义
custom
PageNointeger

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

1
PageSizeinteger

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

10
SortBystring

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

枚举值:
  • asc按CreateTime升序
  • desc按CreateTime倒序
desc

返回参数

名称类型描述示例值
object

响应数据。

RequestIdstring

请求 ID。

******11-DB8D-4A9A-875B-275798******
TemplateListobject []

模板列表。

TemplateIdstring

模板 ID。

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

模板名称。

模板1
Typestring

模板类型。

枚举值:
  • system系统预置
  • custom自定义
custom
TimeIntervalinteger

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

10
CreateTimestring

创建时间。

2022-07-20T02:48:58Z
PageNointeger

页码。

1
PageSizeinteger

页宽。

10
SortBystring

排序。

desc
TotalCountlong

总数。

100

示例

正常返回示例

JSON格式

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

错误码

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

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