ListBatchMediaProducingJobs - 列出符合条件的一键成片任务

列出符合条件的一键成片任务,可以根据任务类型、状态等条件查询。

调试

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

授权信息

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

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

请求参数

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

一键成片任务 Id

****d80e4e4044975745c14b****
JobTypestring

任务类型

枚举值:
  • Script脚本化素材混剪
  • Smart_Mix智能混编素材混剪
Script
Statusstring

任务状态

枚举值:
  • Finished处理完成
  • Init初始化
  • Failed失败
  • Processing处理中
Finished
StartTimestring

开始时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2022-02-02T00:00:00Z
EndTimestring

结束时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2023-06-05T15:59:59Z
SortBystring

查询结果排序。取值:

  • desc(默认值):按创建时间倒序。
  • asc:按创建时间升序。
枚举值:
  • asc按照创建时间正序
  • desc按照创建时间倒序
desc
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕

mRZkKAovub0xWVfH14he4Q==
MaxResultsinteger

本次请求所返回的最大记录条数

100

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

******3B-0E1A-586A-AC29-742247******
EditingBatchJobListarray<object>

一键成片任务列表

EditingBatchJobobject

一键成片任务列表

JobIdstring

一键成片任务 Id

******7ecbee4c6d9b8474498e******
InputConfigstring

用户合成输出配置。

{ "MediaGroupArray": [{ "MediaArray": [ "****9d46c886b45481030f6e****", "****6c886b4549d481030f6e****" ] }, { "MediaArray": [ "****d46c886810b454930f6e****", "****4549d886810b46c30f6e****" ] }], "TitleArray": [ "回龙观盒马鲜生开业啦"], "SpeechTextArray": [ "附近的商场新开了一家盒马鲜生,今天是第一天开业"] }
EditingConfigstring

剪辑相关配置。具体结构定义,请参见 EditingConfig 配置说明。

{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfigstring

输出配置。具体结构定义,请参见 OutputConfig 配置说明。

{ "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4", "Count": 20, "MaxDuration": 15, "Width": 1080, "Height": 1920, "Video": {"Crf": 27} }
Statusstring

任务状态。

枚举值:
  • Finished处理完成
  • Init初始化
  • Failed失败
  • Processing处理中
Finished
UserDatastring

自定义设置,Json 格式,长度限制为 512 字节。支持自定义回调地址配置

{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}
Extendstring

任务扩展信息

{}
CreateTimestring

创建时间,UTC 时间格式

2023-06-09T06:36:48Z
ModifiedTimestring

最后修改时间

2023-06-09T06:37:58Z
CompleteTimestring

完成时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2023-06-09T06:38:09Z
JobTypestring

任务类型

枚举值:
  • Script脚本化素材混剪
  • Smart_Mix智能混编素材混剪
Script
NextTokenstring

下一次查询的开始 Token。

8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResultsinteger

分页大小。最大不超过 100。

默认值:10

100

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "EditingBatchJobList": [
    {
      "JobId": "******7ecbee4c6d9b8474498e******",
      "InputConfig": "{\n  \"MediaGroupArray\": [{\n      \"MediaArray\": [\n        \"****9d46c886b45481030f6e****\",\n        \"****6c886b4549d481030f6e****\" ]\n    }, {\n      \"MediaArray\": [\n        \"****d46c886810b454930f6e****\",\n        \"****4549d886810b46c30f6e****\" ]\n  }],\n  \"TitleArray\": [\n      \"回龙观盒马鲜生开业啦\"],\n  \"SpeechTextArray\": [\n      \"附近的商场新开了一家盒马鲜生,今天是第一天开业\"]\n}",
      "EditingConfig": "{\n  \"MediaConfig\": {\n      \"Volume\": 0\n  },\n  \"SpeechConfig\": {\n      \"Volume\": 1\n  },\n \"BackgroundMusicConfig\": {\n      \"Volume\": 0.3\n  }\n}",
      "OutputConfig": "{\n  \"MediaURL\": \"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\",\n  \"Count\": 20,\n  \"MaxDuration\": 15,\n  \"Width\": 1080,\n  \"Height\": 1920,\n  \"Video\": {\"Crf\": 27}\n}",
      "Status": "Finished",
      "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}或{\"NotifyAddress\":\"https://xx.xx.xxx\"}或{\"NotifyAddress\":\"ice-callback-demo\"}",
      "Extend": "{}",
      "CreateTime": "2023-06-09T06:36:48Z",
      "ModifiedTime": "2023-06-09T06:37:58Z",
      "CompleteTime": "2023-06-09T06:38:09Z\n",
      "JobType": "Script"
    }
  ],
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "MaxResults": 100
}

错误码

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