文档

ListSnapshotJobs - 获取截图任务列表

更新时间:

获取截图任务列表。

调试

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

授权信息

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

请求参数

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

任务创建时间筛选条件的起始时间。

2022-07-12T00:00:00Z
EndOfCreateTimestring

任务创建时间筛选条件的结束时间。

2022-07-14T00:00:00Z
Statusstring

任务状态。

枚举值:
  • Init已提交
  • Success成功
  • Fail失败
Success
OrderBystring

排序顺序。取值:

  1. CreateTimeAsc
  2. CreateTimeDesc
CreateTimeDesc
JobIdstring

任务 ID

****20b48fb04483915d4f2cd8ac****
PageSizeinteger

分页大小,每页显示条数。默认值为 20,最大值为 100。

20
NextPageTokenstring

连续分页查询时下一页的标记。

****20b48fb04483915d4f2cd8ac****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

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

任务列表。

JobIdstring

任务 ID

****20b48fb04483915d4f2cd8ac****
TriggerSourcestring

请求触发来源

枚举值:
  • Console控制台
  • Workflow工作流
  • APIAPI
API
Namestring

任务名称

SampleJob
Typestring

任务类型

枚举值:
  • WebVttWebVTT截图
  • Sprite雪碧图截图
  • Normal普通静态截图
Sprite
Inputobject

任务输入

Typestring

输入类型,取值:

  1. OSS:oss 文件地址
  2. Media:媒资 ID
OSS
Mediastring

输入媒体。当 Type 为 OSS 时填入 OSS 地址,Type 为 Media 时填入媒资 ID。 OSS 地址规则为: 1.OSS://bucket/object 2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。

oss://bucket/object.mp4
Outputobject

任务输出

Typestring

输出类型,取值:

  1. OSS:oss 文件地址
  2. Media:媒资 ID
OSS
Mediastring

输出媒体。当 Type 为 OSS 时填入 OSS 地址,Type 为 Media 时填入媒资 ID。 OSS 地址规则为:

  1. OSS://bucket/object
  2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object

其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。 截取多张静态截图时,object 必须要带有”{Count}“占位符;截取雪碧图时,object 必须要带有“{TileCount}”占位符。WebVTT 截图 object 的后缀必须是“.vtt”。

http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg
Countinteger

截图数量

10
Asyncboolean

是否异步截图

true
TemplateIdstring

模板 ID

****20b48fb04483915d4f2cd8ac****
PipelineIdstring

管道 ID

****20b48fb04483915d4f2cd8ac****
Statusstring

任务状态。

  • Success:成功

  • Fail:失败

  • Init:已提交

Success
SubmitTimestring

任务提交时间

2022-07-12T16:17:54Z
FinishTimestring

任务完成时间

2022-07-12T16:30:54Z
CreateTimestring

创建时间

2022-07-12T16:17:54Z
ModifiedTimestring

最后修改时间

2022-07-12T16:30:54Z
NextPageTokenstring

查询下一页标识

****20b48fb04483915d4f2cd8ac****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Jobs": [
    {
      "JobId": "****20b48fb04483915d4f2cd8ac****",
      "TriggerSource": "API",
      "Name": "SampleJob",
      "Type": "Sprite",
      "Input": {
        "Type": "OSS",
        "Media": "oss://bucket/object.mp4"
      },
      "Output": {
        "Type": "OSS",
        "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg"
      },
      "Count": 10,
      "Async": true,
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "PipelineId": "****20b48fb04483915d4f2cd8ac****",
      "Status": "Success",
      "SubmitTime": "2022-07-12T16:17:54Z",
      "FinishTime": "2022-07-12T16:30:54Z",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:30:54Z"
    }
  ],
  "NextPageToken": "****20b48fb04483915d4f2cd8ac****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-07-15新增 OpenAPI看变更集
2022-07-11新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈