本接口用于提交生成动态图像的任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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"} |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-08-10 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-07-11 | 新增 OpenAPI | 查看变更详情 |