GetLiveEditingJob - 查询直播剪辑作业

更新时间:
复制为 MD 格式

获取剪辑合成作业的详细信息,具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。 本接口仅支持查询近一年的直播剪辑任务数据。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:GetLiveEditingJob

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JobId

string

直播剪辑 Jobld

****d80e4e4044975745c14b****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID

****36-3C1E-4417-BDB2-1E034F****

LiveEditingJob

object

直播剪辑任务

JobId

string

直播剪辑任务 ID

****cdb3e74639973036bc84****

ProjectId

string

直播剪辑工程 ID

****fddd7748b58bf1d47e95****

Status

string

直播剪辑作业状态,取值可能为如下值:

  • Init (初始状态)

  • Queuing(排队中)

  • Processing(处理中)

  • Success(成功)

  • Failed(失败)

Success

Clips

string

剪辑片段列表

[{\"StartTime\": \" 2021-06-21T08:01:00Z\", \"EndTime\": \" 2021-06-21T08:03:00Z\" }]

UserData

string

用户数据

{"key": "value'}

CreationTime

string

直播剪辑作业创建时间,格式为 utc 时间。

2020-12-23T13:33:40Z

ModifiedTime

string

直播剪辑作业修改时间,格式为 utc 时间。

2020-12-23T13:33:49Z

CompleteTime

string

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

2020-12-23T13:33:52Z

MediaId

string

输出成品的资源 Id

****0cc6ba49eab379332c5b****

MediaURL

string

输出成品的资源文件 URL

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

Code

string

剪辑合成作业错误码 注:作业失败时关注该字段

InvalidParameter

Message

string

剪辑合成作业错误信息 注:作业失败时关注该字段

The specific parameter LiveStreamConfig is not valid.

LiveStreamConfig

object

直播剪辑配置

AppName

string

播流所属应用名称

app

DomainName

string

播流所属域名

domain.com

StreamName

string

播流所属流名

streamName

MediaProduceConfig

object

直播剪辑合成配置

Mode

string

剪辑模式,默认 Accurate

Accurate

OutputMediaConfig

object

输出成片的存储配置

MediaURL

string

输出成片的文件地址

https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4

StorageLocation

string

  • 当 OutputMediaTarget 的目标为 vod-media 时, 指定 storage location 来存储媒资到 VOD;

  • storage location 是 VOD 中的文件存储位置, 不包含 http:// 的前缀, 如:outin-xxxxxx.oss-cn-shanghai.aliyuncs.com。

outin-xxxxxx.oss-cn-shanghai.aliyuncs.com

FileName

string

当 OutputMediaTarget 的目标为 vod-media 时,指定 fileName(包含文件后缀,不含路径)作为输出文件名

test.mp4

Width

integer

输出成品的宽。可以不填,默认值是多个素材的最大宽

640

Height

integer

输出成品的高。可以不填,默认值是多个素材的最大高

480

Bitrate

integer

输出成品的码率,单位为 Kbps。可以不填,默认值是多个素材的最高码率

1000

VodTemplateGroupId

string

合成成片输出到 vod,指定 vod 转码模板组。如不需要 VOD 转码,请填写 "VOD_NO_TRANSCODE".

VOD_NO_TRANSCODE

示例

正常返回示例

JSON格式

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "LiveEditingJob": {
    "JobId": "****cdb3e74639973036bc84****",
    "ProjectId": "****fddd7748b58bf1d47e95****",
    "Status": "Success",
    "Clips": "[{\\\"StartTime\\\": \\\" 2021-06-21T08:01:00Z\\\",  \\\"EndTime\\\": \\\" 2021-06-21T08:03:00Z\\\" }]",
    "UserData": "{\"key\": \"value'}",
    "CreationTime": "2020-12-23T13:33:40Z",
    "ModifiedTime": "2020-12-23T13:33:49Z",
    "CompleteTime": "2020-12-23T13:33:52Z",
    "MediaId": "****0cc6ba49eab379332c5b****",
    "MediaURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
    "Code": "InvalidParameter",
    "Message": "The specific parameter LiveStreamConfig is not valid.",
    "LiveStreamConfig": {
      "AppName": "app",
      "DomainName": "domain.com",
      "StreamName": "streamName"
    },
    "MediaProduceConfig": {
      "Mode": "Accurate"
    },
    "OutputMediaConfig": {
      "MediaURL": "https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4",
      "StorageLocation": "outin-xxxxxx.oss-cn-shanghai.aliyuncs.com",
      "FileName": "test.mp4",
      "Width": 640,
      "Height": 480,
      "Bitrate": 1000,
      "VodTemplateGroupId": "VOD_NO_TRANSCODE"
    }
  }
}

错误码

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

变更历史

更多信息,参考变更详情