本接口用于提交生成动态图像的任务。
接口说明
该接口为异步接口,提交任务后返回任务 ID(此时任务尚未完成,任务将进入后台排队异步执行),最终结果将通过回调通知,也可通过查询动图任务详细信息主动查询任务状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:SubmitDynamicImageJob |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Name |
string |
否 |
任务名称 |
SampleJob |
| Input |
object |
是 |
任务输入 |
|
| Type |
string |
是 |
输入类型,取值:
枚举值:
|
OSS |
| Media |
string |
是 |
输入媒体。
OSS 地址规则为:
其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。 说明
URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。 |
oss://bucket/object.mp4 |
| Output |
object |
是 |
任务输出 |
|
| Type |
string |
是 |
输出类型,取值:
枚举值:
|
Media |
| Media |
string |
是 |
输出媒体,支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为
其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。 说明
URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。 |
****96e8864746a0b6f3**** |
| TemplateConfig |
object |
是 |
截图模板配置 |
|
| TemplateId |
string |
是 |
模板 ID |
****96e8864746a0b6f3**** |
| OverwriteParams |
object |
否 |
覆盖参数 |
|
| Format |
string |
否 |
动图格式,取值:
枚举值:
|
gif |
| Width |
integer |
否 |
输出动图宽度。取值范围:[128, 4096]。 |
1024 |
| Height |
integer |
否 |
输出动图高度。取值范围:[128, 4096]。 |
720 |
| Fps |
integer |
否 |
帧率。取值范围:[1, 60]。 |
15 |
| ScanMode |
string |
否 |
扫描模式。可取值:
枚举值:
|
progressive |
| LongShortMode |
boolean |
否 |
是否开启横竖屏自适应(长短边模式)。取值:
默认值:true。 说明
转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。 枚举值:
|
false |
| TimeSpan |
object |
否 |
时间线参数 |
|
| Seek |
string |
否 |
开始时间点。
|
01:59:59.999 或 32000.23 |
| Duration |
string |
否 |
持续时长。
|
01:59:59.999 或 32000.23 |
| End |
string |
否 |
截尾时长,表示切掉尾部的若干时长。设置此值时,参数 Duration 失效。
|
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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。