SubmitDynamicImageJob - 提交动图任务

更新时间:
复制为 MD 格式

本接口用于提交生成动态图像的任务。

接口说明

该接口为异步接口,提交任务后返回任务 ID(此时任务尚未完成,任务将进入后台排队异步执行),最终结果将通过回调通知,也可通过查询动图任务详细信息主动查询任务状态。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:SubmitDynamicImageJob

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Name

string

任务名称

SampleJob

Input

object

任务输入

Type

string

输入类型,取值:

  • OSS:OSS 文件地址。

  • Media:媒资 ID。

枚举值:

  • Media :

    媒资 ID

  • OSS :

    oss 地址

OSS

Media

string

输入媒体。

  • 当 Type 为 OSS 时填入 OSS 地址。

  • Type 为 Media 时填入媒资 ID。

OSS 地址规则为:

  1. oss://bucket/object

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

其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。

说明

URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。

oss://bucket/object.mp4

Output

object

任务输出

Type

string

输出类型,取值:

  • OSS:oss 文件地址。

  • Media:媒资 ID。

枚举值:

  • Media :

    媒资 ID

  • OSS :

    oss 地址

Media

Media

string

输出媒体,支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为

  • oss://bucket/object

  • http(s)://bucket.oss-[regionId].aliyuncs.com/object

其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。

说明

URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。

****96e8864746a0b6f3****

TemplateConfig

object

截图模板配置

TemplateId

string

模板 ID

****96e8864746a0b6f3****

OverwriteParams

object

覆盖参数

Format

string

动图格式,取值:

  • gif。

  • webp。

枚举值:

  • gif :

    gif

  • webp :

    webp

gif

Width

integer

输出动图宽度。取值范围:[128, 4096]。

1024

Height

integer

输出动图高度。取值范围:[128, 4096]。

720

Fps

integer

帧率。取值范围:[1, 60]。

15

ScanMode

string

扫描模式。可取值:

  • interlaced:交叉扫描。

  • progressive:顺序扫描。默认值。

枚举值:

  • progressive :

    顺序扫描

  • interlaced :

    交叉扫描

progressive

LongShortMode

boolean

是否开启横竖屏自适应(长短边模式)。取值:

  • true:开启横竖屏自适应。

  • false:关闭横竖屏自适应。

默认值:true

说明

转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。

枚举值:

  • true :

    true

  • false :

    false

false

TimeSpan

object

时间线参数

Seek

string

开始时间点。

  • 格式:hh:mm:ss[.SSS]sssss[.SSS]

  • 取值范围 :[00:00:00.000,23:59:59.999][0.000,86399.999]

01:59:59.999 或 32000.23

Duration

string

持续时长。

  • 格式:hh:mm:ss[.SSS]sssss[.SSS]

  • 取值范围 :[00:00:00.000,23:59:59.999][0.000,86399.999]

01:59:59.999 或 32000.23

End

string

截尾时长,表示切掉尾部的若干时长。设置此值时,参数 Duration 失效。

  • 格式:hh:mm:ss[.SSS]sssss[.SSS]

  • 取值范围 :[00:00:00.000,23:59:59.999][0.000,86399.999]

01:59:59.999 或 32000.23

ScheduleConfig

object

调度配置

PipelineId

string

管道 ID

****96e8864746a0b6f3****

Priority

integer

优先级,1-10,默认 6。数值越大,优先级越高。

6

UserData

string

用户自定义信息

{"SampleKey": "SampleValue"}

返回参数

名称

类型

描述

示例值

object

PlainResponse

RequestId

string

请求 ID

******11-DB8D-4A9A-875B-275798******

JobId

string

任务 ID

****20b48fb04483915d4f2cd8ac****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

错误码

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

变更历史

更多信息,参考变更详情