调用ListLiveSnapshotJobs获取实时截图任务列表,可分页获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StartTime | string | 否 | 查询开始时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。
| 2022-02-02T00:00:00Z |
EndTime | string | 否 | 查询结束时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。
| 2022-02-02T23:59:59Z |
SearchKeyWord | string | 否 | 搜索关键词,任务 ID/名称,名称支持模糊搜索。
| ****a046-263c-3560-978a-fb287782**** |
Status | string | 否 | 任务状态过滤,默认查询全部。 枚举值:
| |
PageNo | integer | 否 | 页码,[1, n),默认是 1。 | 1 |
PageSize | integer | 否 | 页宽,[1, 100],默认是 10。 | 10 |
SortBy | string | 否 | 排序,按 CreateTime 排序,默认是 desc。 枚举值:
| desc |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobList": [
{
"JobId": "****a046-263c-3560-978a-fb287782****",
"JobName": "截图任务1",
"TemplateId": "****a046-263c-3560-978a-fb287666****",
"TemplateName": "模板1",
"Status": "started",
"SnapshotOutput": {
"StorageType": "oss",
"Endpoint": "oss-cn-shanghai.aliyuncs.com",
"Bucket": "testbucket"
},
"TimeInterval": 5,
"CreateTime": "2022-07-20T02:48:58Z"
}
],
"PageNo": 1,
"PageSize": 10,
"SortBy": "desc",
"TotalCount": 100
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | %s | - |
400 | InvalidParameter | %s | - |
400 | MalformedStartTime | Specified parameter StartTime is not valid. | - |
400 | MalformedEndTime | Specified parameter EndTime is not valid. | - |
400 | EndTimeMismatch | Specified end time does not math the specified start time. | - |
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. | 账号未开通智能媒体生产服务。 |
500 | InternalError | The request processing has failed due to some unknown error. | 后台发生未知错误,请稍后重试或联系客服解决。 |
访问错误中心查看更多错误码。