调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
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 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | %s | - |
400 | InvalidParameter | %s | - |
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. | 无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。) |
500 | InternalError | The request processing has failed due to some unknown error. | 后台发生未知错误,请稍后重试或联系客服解决。 |
访问错误中心查看更多错误码。