文档

GetDynamicImageJob - 查询动图任务详细信息

更新时间:

查询动图任务详细信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetDynamicImageJob
  • 全部资源
    *

请求参数

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

动图任务 ID。

****d80e4e4044975745c14b****

返回参数

名称类型描述示例值
object

PlainResponse

RequestIdstring

请求 ID

******36-3C1E-4417-BDB2-1E034F******
DynamicImageJobobject

截图任务信息

JobIdstring

任务 ID

****d80e4e4044975745c14b****
TriggerSourcestring

请求触发来源

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

任务名称

SampleJob
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://test-bucket/sample-input.mp4
OssFileobject

OSS 三元组

Bucketstring

OSS Bucket

test-bucket
Locationstring

OSS Location

oss-cn-shanghai
Objectstring

OSS Object

sample-input.mp4
Outputobject

任务输出

Typestring

输入类型,取值: OSS:oss 文件地址 Media:媒资 ID

Media
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 为文件路径。
****d80e4e4044975745c14b****
OssFileobject

OSS 三元组

Bucketstring

OSS Bucket

sample-bucket
Locationstring

OSS Location

oss-cn-shanghai
Objectstring

OSS Object

path/to/object
OutputUrlstring

输出动图的 URL 地址

http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif
TemplateConfigstring

动图模板配置

{"Format":"gif","Fps":5,"Height":1080,"Width":1920}
TemplateIdstring

模板 ID

****d80e4e4044975745c14b****
PipelineIdstring

管道 ID

****d80e4e4044975745c14b****
Statusstring

任务状态

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

错误码

ResourceNotFound
Messagestring

错误消息

The specified resource for "CustomTemplate" could not be found.
SubmitTimestring

任务提交时间

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

任务完成时间

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

用户自定义数据

{"sampleParam": "sampleValue"}
CreateTimestring

创建时间

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

最后一次修改时间

2022-07-12T16:30:54Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******36-3C1E-4417-BDB2-1E034F******",
  "DynamicImageJob": {
    "JobId": "****d80e4e4044975745c14b****\n",
    "TriggerSource": "API",
    "Name": "SampleJob",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/sample-input.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "sample-input.mp4"
      }
    },
    "Output": {
      "Type": "Media",
      "Media": "****d80e4e4044975745c14b****",
      "OssFile": {
        "Bucket": "sample-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "path/to/object"
      }
    },
    "OutputUrl": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif",
    "TemplateConfig": "{\"Format\":\"gif\",\"Fps\":5,\"Height\":1080,\"Width\":1920}",
    "TemplateId": "****d80e4e4044975745c14b****",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"CustomTemplate\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"sampleParam\": \"sampleValue\"}",
    "CreateTime": "2022-07-12T16:17:54Z",
    "ModifiedTime": "2022-07-12T16:30:54Z"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-07-15新增 OpenAPI查看变更详情
2022-07-11新增 OpenAPI查看变更详情