文档

SubmitDynamicImageJob - 提交动图任务

更新时间:

提交动图任务。

调试

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

授权信息

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

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

请求参数

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

任务名称

SampleJob
Inputobject

任务输入

Typestring

输入类型,取值:

  1. OSS:oss 文件地址
  2. Media:媒资 ID
枚举值:
  • Media媒资ID
  • OSSoss地址
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 为文件路径。

说明 URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。
oss://bucket/object.mp4
Outputobject

任务输出

Typestring

输出类型,取值:

  1. OSS:oss 文件地址
  2. Media:媒资 ID
枚举值:
  • Media媒资ID
  • OSSoss地址
Media
Mediastring

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

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

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

说明 URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。
****96e8864746a0b6f3****
TemplateConfigobject

截图模板配置

TemplateIdstring

模板 ID

****96e8864746a0b6f3****
OverwriteParamsobject

覆盖参数

Formatstring

动图格式,取值:

  • gif
  • webp
gif
Widthinteger

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

1024
Heightinteger

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

720
Fpsinteger

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

15
ScanModestring

扫描模式。可取值:

  • interlaced:交叉扫描。

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

progressive
LongShortModeboolean

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

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

默认值:true

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

时间线参数

Seekstring

开始时间点。

  • 格式:hh:mm:ss[.SSS]sssss[.SSS]
  • 取值范围 :[00:00:00.000,23:59:59.999][0.000,86399.999]
01:59:59.999 或 32000.23
Durationstring

持续时长。

  • 格式:hh:mm:ss[.SSS]sssss[.SSS]
  • 取值范围 :[00:00:00.000,23:59:59.999][0.000,86399.999]
01:59:59.999 或 32000.23
Endstring

截尾时长,表示切掉尾部的若干时长。设置此值时,参数 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
ScheduleConfigobject

调度配置

PipelineIdstring

管道 ID

****96e8864746a0b6f3****
Priorityinteger

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

6
UserDatastring

用户自定义信息

{"SampleKey": "SampleValue"}

返回参数

名称类型描述示例值
object

PlainResponse

RequestIdstring

请求 ID

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

任务 ID

****20b48fb04483915d4f2cd8ac****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-10API 内部配置变更,不影响调用查看变更详情
2022-07-11新增 OpenAPI查看变更详情