文档

ListLiveSnapshotJobs - 获取实时截图任务列表

更新时间:

调用ListLiveSnapshotJobs获取实时截图任务列表,可分页获取。

调试

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

授权信息

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

请求参数

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

查询开始时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

  • 默认为 7 天前。
  • StartTime 与 EndTime 间隔不能超过 30 天。
2022-02-02T00:00:00Z
EndTimestring

查询结束时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

  • 默认为 StartTime+7 天。
  • StartTime 与 EndTime 间隔不能超过 30 天。
2022-02-02T23:59:59Z
SearchKeyWordstring

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

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

任务状态过滤,默认查询全部。

枚举值:
  • init未启动
  • paused已停止
  • started执行中
PageNointeger

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

1
PageSizeinteger

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

10
SortBystring

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

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

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

任务列表。

JobIdstring

任务 ID。

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

任务名称。

截图任务1
TemplateIdstring

模板 ID。

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

模板名称。

模板1
Statusstring

任务状态。

枚举值:
  • init未启动
  • paused已停止
  • started执行中
started
SnapshotOutputobject

输出信息。

StorageTypestring

存储类型,目前只支持 oss。

oss
Endpointstring

输出终端,type=oss 时返回 OSS 域名。

oss-cn-shanghai.aliyuncs.com
Bucketstring

输出终端的 Bucket,type=oss 时返回 OSS Bucket。

testbucket
TimeIntervalinteger

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

5
CreateTimestring

创建时间。

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

页码。

1
PageSizeinteger

页宽。

10
SortBystring

排序。

desc
TotalCountlong

总数。

100

示例

正常返回示例

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

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