调用ListSnapshotJobs接口获取截图任务列表-智能媒体服务-阿里云-智能媒体服务(IMS)-阿里云帮助中心

获取截图任务列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListSnapshotJobs

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
StartOfCreateTime	string	否	任务创建时间筛选条件的起始时间。	2022-07-12T00:00:00Z
EndOfCreateTime	string	否	任务创建时间筛选条件的结束时间。	2022-07-14T00:00:00Z
Status	string	否	任务状态。枚举值： Init : 已提交 Success : 成功 Fail : 失败	Success
OrderBy	string	否	排序顺序。取值： CreateTimeAsc CreateTimeDesc 枚举值： CreateTimeDesc : 创建时间逆序排列 CreateTimeAsc : 创建时间顺序排列	CreateTimeDesc
JobId	string	否	任务 ID	**20b48fb04483915d4f2cd8ac**
PageSize	integer	否	分页大小，每页显示条数。默认值为 20，最大值为 100。	20
NextPageToken	string	否	连续分页查询时下一页的标记。	**20b48fb04483915d4f2cd8ac**

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	****11-DB8D-4A9A-875B-275798****
Jobs	array<object>	任务列表。
	array<object>	截图任务信息。
JobId	string	任务 ID	**20b48fb04483915d4f2cd8ac**
TriggerSource	string	请求触发来源枚举值： Console : 控制台 Workflow : 工作流 API : API	API
Name	string	任务名称	SampleJob
Type	string	任务类型枚举值： WebVtt : WebVTT 截图 Sprite : 雪碧图截图 Normal : 普通静态截图	Sprite
Input	object	任务输入
Type	string	输入类型，取值： OSS：oss 文件地址 Media：媒资 ID	OSS
Media	string	输入媒体。当 Type 为 OSS 时填入 OSS 地址，Type 为 Media 时填入媒资 ID。 OSS 地址规则为： OSS://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称，object 为文件路径。	oss://bucket/object.mp4
Output	object	任务输出
Type	string	输出类型，取值： OSS：oss 文件地址 Media：媒资 ID	OSS
Media	string	输出媒体。当 Type 为 OSS 时填入 OSS 地址，Type 为 Media 时填入媒资 ID。 OSS 地址规则为： OSS://bucket/object 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
Count	integer	截图数量	10
Async	boolean	是否异步截图	true
TemplateId	string	模板 ID	**20b48fb04483915d4f2cd8ac**
PipelineId	string	管道 ID	**20b48fb04483915d4f2cd8ac**
Status	string	任务状态。 Success：成功 Fail：失败 Init：已提交枚举值： Init : 已提交 Success : 成功 Fail : 失败	Success
SubmitTime	string	任务提交时间	2022-07-12T16:17:54Z
FinishTime	string	任务完成时间	2022-07-12T16:30:54Z
CreateTime	string	创建时间	2022-07-12T16:17:54Z
ModifiedTime	string	最后修改时间	2022-07-12T16:30:54Z
NextPageToken	string	查询下一页标识	**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****"
}

错误码

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

变更历史

更多信息，参考变更详情。