文档

GetMediaProducingJob - 查询剪辑合成作业

更新时间:

获取剪辑合成作业的详细信息,包括剪辑合成任务的任务状态、时间线、模板及数据等。 本接口仅支持查询近一年的剪辑任务数据。

调试

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

授权信息

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

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

请求参数

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

剪辑合成作业 Id

****cdb3e74639973036bc84****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

****83B7-7F87-4792-BFE9-63CD2137****
MediaProducingJobobject

云剪辑工程信息

JobIdstring

剪辑合成作业 Id

****cdb3e74639973036bc84****
ProjectIdstring

云剪辑工程 Id

****fddd7748b58bf1d47e95****
MediaIdstring

输出成品的资源 Id

****0cc6ba49eab379332c5b****
MediaURLstring

输出成品的资源文件 URL

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4
Timelinestring

剪辑合成作业对应的时间线

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}
TemplateIdstring

剪辑合成作业对应的模板 Id

****6e76134d739cc3e85d3e****
ClipsParamstring

剪辑合成作业对应的模板参数

{"VideoArray":["****05512043f49f697f7425****","****05512043f49f697f7425****","****05512043f49f697f7425****"]}
Durationfloat

输出成品的时长

注:当合成任务成功且输出成品的类型为音视频时,该字段有值。

30.500000
CreateTimestring

剪辑合成作业创建时间,格式为 utc 时间。

格式为:"YYYY-MM-DD'T'hh:mm:ss'Z'"。

2020-12-23T13:33:40Z
CompleteTimestring

剪辑合成作业完成时间,格式为 utc 时间。

格式为:"YYYY-MM-DD'T'hh:mm:ss'Z'"。

2020-12-23T13:33:52Z
ModifiedTimestring

剪辑合成作业修改时间,格式为 utc 时间。

格式为:"YYYY-MM-DD'T'hh:mm:ss'Z'"。

2020-12-23T13:33:49Z
Statusstring

剪辑合成作业状态,取值可能为如下值:

-Init (初始状态)

-Queuing(排队中)

-Processing(处理中)

-Success(成功)

-Failed(失败)

Failed
Codestring

剪辑合成作业错误码

注:作业失败时关注该字段

ExceededMaximumValue
Messagestring

剪辑合成作业错误信息

注:作业失败时关注该字段

The specified "Width_Height" has exceeded maximum value.
VodMediaIdstring

如果剪辑任务的成片输出到 VOD,成片会注册成一个 VOD 的媒资,vodMediaId 即该媒资在 VOD 的媒资 ID

****332c5b0cc6ba49eab379****
UserDatastring

用户自定义设置,JSON 格式。

{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}
SubJobMaterialsstring

当该剪辑任务是批量智能一键成片的子任务,返回子任务用到的口播文案、标题等素材信息。

{"Title": "标题", "SpeechText": "批量智能一键成片口播文案"}

示例

正常返回示例

JSON格式

{
  "RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
  "MediaProducingJob": {
    "JobId": "****cdb3e74639973036bc84****",
    "ProjectId": "****fddd7748b58bf1d47e95****",
    "MediaId": "****0cc6ba49eab379332c5b****",
    "MediaURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
    "TemplateId": "****6e76134d739cc3e85d3e****",
    "ClipsParam": "{\"VideoArray\":[\"****05512043f49f697f7425****\",\"****05512043f49f697f7425****\",\"****05512043f49f697f7425****\"]}",
    "Duration": 30.5,
    "CreateTime": "2020-12-23T13:33:40Z",
    "CompleteTime": "2020-12-23T13:33:52Z",
    "ModifiedTime": "2020-12-23T13:33:49Z",
    "Status": "Failed",
    "Code": "ExceededMaximumValue",
    "Message": "The specified \"Width_Height\" has exceeded maximum value.",
    "VodMediaId": "****332c5b0cc6ba49eab379****",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\",\"Key\":\"Valuexxx\"}",
    "SubJobMaterials": "{\"Title\": \"标题\", \"SpeechText\": \"批量智能一键成片口播文案\"}"
  }
}

错误码

HTTP status code错误码错误信息
400InvalidParameterThe specified parameter \ is not valid.
404JobNotFoundThe specified job not found

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-03OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2021-11-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情