查询动图任务详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:GetDynamicImageJob |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JobId |
string |
否 |
动图任务 ID。 |
****d80e4e4044975745c14b**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PlainResponse |
||
| RequestId |
string |
请求 ID |
******36-3C1E-4417-BDB2-1E034F****** |
| DynamicImageJob |
object |
截图任务信息 |
|
| JobId |
string |
任务 ID |
****d80e4e4044975745c14b**** |
| TriggerSource |
string |
请求触发来源 枚举值:
|
API |
| Name |
string |
任务名称 |
SampleJob |
| Input |
object |
任务输入 |
|
| Type |
string |
输入类型,取值:
枚举值:
|
OSS |
| Media |
string |
输入媒体。当 Type 为 OSS 时填入 OSS 地址,Type 为 Media 时填入媒资 ID。 OSS 地址规则为:
其中 bucket 为和当前项目处于同一区域的 OSS bucket 名称,object 为文件路径。 |
oss://test-bucket/sample-input.mp4 |
| OssFile |
object |
OSS 三元组 |
|
| Bucket |
string |
OSS Bucket |
test-bucket |
| Location |
string |
OSS Location |
oss-cn-shanghai |
| Object |
string |
OSS Object |
sample-input.mp4 |
| Output |
object |
任务输出 |
|
| Type |
string |
输入类型,取值: OSS:oss 文件地址 Media:媒资 ID 枚举值:
|
Media |
| Media |
string |
输入媒体。当 Type 为 OSS 时填入 OSS 地址,Type 为 Media 时填入媒资 ID。 OSS 地址规则为:
|
****d80e4e4044975745c14b**** |
| OssFile |
object |
OSS 三元组 |
|
| Bucket |
string |
OSS Bucket |
sample-bucket |
| Location |
string |
OSS Location |
oss-cn-shanghai |
| Object |
string |
OSS Object |
path/to/object |
| OutputUrl |
string |
输出动图的 URL 地址 |
http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif |
| TemplateConfig |
string |
动图模板配置 |
{"Format":"gif","Fps":5,"Height":1080,"Width":1920} |
| TemplateId |
string |
模板 ID |
****d80e4e4044975745c14b**** |
| PipelineId |
string |
管道 ID |
****d80e4e4044975745c14b**** |
| Status |
string |
任务状态 枚举值:
|
Success |
| Code |
string |
错误码 |
ResourceNotFound |
| Message |
string |
错误消息 |
The specified resource for "CustomTemplate" could not be found. |
| SubmitTime |
string |
任务提交时间 |
2022-07-12T16:17:54Z |
| FinishTime |
string |
任务完成时间 |
2022-07-12T16:30:54Z |
| UserData |
string |
用户自定义数据 |
{"sampleParam": "sampleValue"} |
| CreateTime |
string |
创建时间 |
2022-07-12T16:17:54Z |
| ModifiedTime |
string |
最后一次修改时间 |
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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。