调用GetSnapshotJob API查询截图任务详细信息-智能媒体服务-阿里云-智能媒体服务(IMS)-阿里云帮助中心

查询截图任务详细信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ice:GetSnapshotJob

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	截图任务 ID。	**d80e4e4044975745c14b**

返回参数

名称	类型	描述	示例值
	object	PlainResponse
RequestId	string	请求 ID	****11-DB8D-4A9A-875B-275798****
SnapshotJob	object	截图任务信息
JobId	string	任务 ID	**d80e4e4044975745c14b**
TriggerSource	string	请求触发来源枚举值： Console : 控制台 Workflow : 工作流 API : API	API
Name	string	任务名称	Test task
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://test-bucket/object.mp4
OssFile	object	OSS 三元组
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	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
OssFile	object	OSS 三元组
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	output-{Count}.jpg
Count	integer	截图数量	8
Async	boolean	是否异步截图。默认：true	true
TemplateId	string	模板 ID	**d80e4e4044975745c14b**
TemplateConfig	string	截图模板配置	{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
PipelineId	string	管道 ID	**d80e4e4044975745c14b**
Status	string	任务状态枚举值： Init : 已提交 Success : 成功 Fail : 失败	Success
Code	string	错误码	ResourceNotFound
Message	string	错误消息	The specified resource for "Pipeline" could not be found.
SubmitTime	string	任务提交时间	2022-07-12T16:17:54Z
FinishTime	string	任务完成时间	2022-07-12T16:30:54Z
UserData	string	用户自定义参数。	{"test parameter": "test value"}
CreateTime	string	创建时间	2022-07-12T16:17:54Z
ModifiedTime	string	最后修改时间	2022-07-12T16:30:54Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SnapshotJob": {
    "JobId": "****d80e4e4044975745c14b****",
    "TriggerSource": "API",
    "Name": "Test task",
    "Type": "Sprite",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/object.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "object.mp4"
      }
    },
    "Output": {
      "Type": "OSS",
      "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "output-{Count}.jpg"
      }
    },
    "Count": 8,
    "Async": true,
    "TemplateId": "****d80e4e4044975745c14b****",
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"Pipeline\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"test parameter\": \"test value\"}",
    "CreateTime": "2022-07-12T16:17:54Z",
    "ModifiedTime": "2022-07-12T16:30:54Z"
  }
}

错误码

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

变更历史

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