查询剪辑任务 - ListEditingJobs
功能介绍
查询剪辑任务的执行状态、任务创建和任务结束的时间等信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
mpc:editingTask:view
List
-
-
-
-
URI
GET /v2/{project_id}/editing/jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参考获取项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| job_id | 是 | Array of strings | 任务ID。一次最多10个 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选,携带的鉴权信息。 |
| X-Project_Id | 否 | String | 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选,请求的发生时间。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 这个字段作为一个请求的唯一标志,用于任务流程追溯。格式:request_id(uuid)-timestamp-hostname |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_array | Array of QueryEditingJob objects | 任务列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 任务ID |
| status | String | 任务执行状态。 取值如下: |
| progress | Integer | 任务执行进度百分比, 取值范围:[0, 100]。 |
| create_time | String | 剪辑任务创建时间。格式 yyyyMMddHHmmss 必须是与时区无关的UTC时间 |
| start_time | String | 剪辑任务开始时间。格式 yyyyMMddHHmmss 必须是与时区无关的UTC时间 |
| end_time | String | 剪辑任务结束时间。格式 yyyyMMddHHmmss 必须是与时区无关的UTC时间 |
| metadata | Array of FileMetaData objects | 输出文件的metadata信息 |
| output | ObsObjInfo object | 输出地址。 |
| editing_output | EditingOutputFileInfo object | 剪辑输出meta信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| bucket | String | OBS的bucket名称。 |
| location | String | OBS桶所在的区域,且必须与使用的MPC区域保持一致。 |
| object | String | OBS对象路径,遵守OSS Object定义。 在字幕场景下,字幕文件名称中禁止携带特殊符号,否则会导致转码任务失败,如:[ |
| file_name | String | 文件名,文件名长度不能超过180个字符。 在作为输出文件名时: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| duration | Long | 输出片源时长。单位:秒 |
| duration_ms | Long | 输出片源时长,单位:毫秒 |
| format | String | 输出封装格式 |
| size | Long | 媒体文件大小。 单位:KByte |
| size_byte | Long | 媒体文件大小。 单位:Byte。 |
| md5 | String | 视频的 md5 值。 说明: 仅转码和解析接口会返回当前字段,且默认不开放,需通过工单申请开通 |
| video_info | EditingVideoInfo object | 视频信息 |
| audio_info | Array of EditingAudioInfo objects | 音频信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| width | Integer | 视频宽度 |
| height | Integer | 视频高度 |
| bitrate | Integer | 视频码率。 单位: kbit/s |
| bitrate_bps | Long | 视频码率。 单位: bit/s |
| frame_rate | Integer | 输出帧率。 |
| codec | String | 视频编码格式 |
| dynamic_range | String | 片源动态范围类型,HDR和SDR |
| duration | String | 视频流时长,单位:秒 |
| duration_ms | String | 视频流时长,单位:毫秒 |
| rotate | Float | 视频拍摄时的选择角度,单位:度。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| codec | String | 音频编码格式 |
| sample | Integer | 音频采样率 |
| channels | Integer | 音频信道 |
| bitrate | Integer | 音频码率。 单位: kbit/s |
| bitrate_bps | Long | 音频码率。 单位: bit/s |
| duration | String | 音频流时长,单位:秒 |
| duration_ms | String | 音频流时长,单位:毫秒 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 这个字段作为一个请求的唯一标志,用于任务流程追溯。格式:request_id(uuid)-timestamp-hostname |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 这个字段作为一个请求的唯一标志,用于任务流程追溯。格式:request_id(uuid)-timestamp-hostname |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
GET https://{endpoint}/v2/{project_id}/editing/jobs?job_id=30647 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询剪辑任务成功。 |
| 400 | 查询剪辑任务失败或请求参数校验失败。 |
| 500 | 服务器内部错误 |
错误码
请参见错误码。