调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:ListLiveSnapshotTemplates |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SearchKeyWord |
string |
否 |
搜索关键词,模板 ID/名称,名称支持模糊搜索。
|
****a046-263c-3560-978a-fb287782**** |
| TemplateIds |
array |
否 |
指定模板 ID 查询。
|
|
|
string |
否 |
****a046-263c-3560-978a-fb287782**** |
||
| Type |
string |
否 |
模板类型,默认是查询全部。 枚举值:
|
custom |
| PageNo |
integer |
否 |
页码,[1, n),默认是 1。 |
1 |
| PageSize |
integer |
否 |
页宽,[1, 100],默认是 10。 |
10 |
| SortBy |
string |
否 |
排序,默认按 CreateTime 排序,默认是 desc。 枚举值:
|
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 |
模板类型。 枚举值:
|
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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。