文档

SearchEditingProject - 搜索云剪辑工程

更新时间:

支持按创建时间、状态搜索。

调试

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

授权信息

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

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

请求参数

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

CreationTime(创建时间)的开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-01-11T12:00:00Z
EndTimestring

CreationTime(创建时间)的结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-01-11T12:00:00Z
Statusstring

云剪辑工程状态。多个用英文逗号(,)分隔。默认获取所有云剪辑工程。

取值范围:

-Draft:草稿。

-Producing:合成中。

-Produced:合成成功。

-ProduceFailed:合成失败。

Producing
SortBystring

结果排序方式。取值范围:

-CreationTime:Desc(默认值):按创建时间倒序。

-CreationTime:Asc:按创建时间升序。

CreationTime:Desc
PageNolong

分页的页码。默认值:1。

1
PageSizelong

分页大小,每页显示条数。默认值为 10,最大值为 100。

10
CreateSourcestring

创建来源:

-OpenAPI

-AliyunConsole

-WebSDK

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
WebSDK
TemplateTypestring

模板类型:

-Timeline

-VETemplate

枚举值:
  • Timeline普通模板
  • VETemplate高级模板
  • None未使用模板
Timeline
ProjectTypestring

剪辑工程类型,默认 EditingProject

  • EditingProject: 普通剪辑工程

  • LiveEditingProject: 直播剪辑工程

EditingProject

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

****9262E3DA-07FA-4862-FCBB6BC61D08*****
ProjectListobject []

云剪辑工程列表。

ProjectIdstring

云剪辑工程 ID。

****fddd7748b58bf1d47e95****
Titlestring

云剪辑工程标题。

title
Timelinestring

云剪辑工程时间线。

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

云剪辑工程描述。

sample description
CoverURLstring

云剪辑工程封面。

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg
CreateTimestring

云剪辑工程创建时间。

2017-01-11T12:00:00Z
ModifiedTimestring

云剪辑工程最新修改时间。

2017-01-11T12:00:00Z
Durationlong

云剪辑工程总时长,单位:秒。

30.100000
Statusstring

所有云剪辑工程状态列表:

-Draft

-Editing

-Producing

-Produced

-ProduceFailed

枚举值:
  • Draft草稿
  • Produced合成完成
  • Editing编辑中
  • Producing合成中
  • ProduceFailed合成失败
PRODUCE_FAILED
ErrorCodestring

云剪辑工程合成失败的错误码。

InvalidParameter
ErrorMessagestring

云剪辑工程合成失败的消息。

"EventTime":"2021-08-12T10:04:15Z","ErrorCode":"InvalidParameter","ErrorMessage":"The specified parameter \"LiveStreamConfig\" is not valid. specified parameter example is not valid.
CreateSourcestring

云剪辑工程编辑方式:

-OpenAPI

-AliyunConsole

-WebSDK

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI
ModifiedSourcestring

最后一次修改来源。

2017-01-11T12:00:00Z
TemplateTypestring

模板类型。

Timeline
ProjectTypestring

剪辑工程类型。

枚举值:
  • LiveEditingProject直播剪辑工程
  • EditingProject普通剪辑工程
EditingProject
BusinessConfigstring

工程业务配置,一般剪辑工程可忽略。

{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
BusinessStatusstring

工程业务状态,一般剪辑工程可忽略

枚举值:
  • BroadCasting直播中
  • ReservationCanceled预约取消
  • LiveFinished直播结束
  • LoadingFailed加载失败
  • Reserving预约中
Reserving
MaxResultslong

本次请求所返回的最大记录条数,最后一页前每页记录条数为 MaxResults 取值。

例如:

正例:10,10,5,反例:10,5,10

10
TotalCountlong

本次请求条件下的数据总量,此参数为可选参数,默认可不返回。

110
NextTokenstring

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

null

示例

正常返回示例

JSON格式

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "ProjectList": [
    {
      "ProjectId": "****fddd7748b58bf1d47e95****",
      "Title": "title",
      "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
      "Description": "sample description",
      "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg",
      "CreateTime": "2017-01-11T12:00:00Z",
      "ModifiedTime": "2017-01-11T12:00:00Z",
      "Duration": 30.1,
      "Status": "PRODUCE_FAILED",
      "ErrorCode": "InvalidParameter",
      "ErrorMessage": "\"EventTime\":\"2021-08-12T10:04:15Z\",\"ErrorCode\":\"InvalidParameter\",\"ErrorMessage\":\"The specified parameter \\\"LiveStreamConfig\\\" is not valid. specified parameter example is not valid.",
      "CreateSource": "OpenAPI",
      "ModifiedSource": "2017-01-11T12:00:00Z",
      "TemplateType": "Timeline",
      "ProjectType": "EditingProject",
      "BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
      "BusinessStatus": "Reserving"
    }
  ],
  "MaxResults": 10,
  "TotalCount": 110,
  "NextToken": "null"
}

错误码

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

  • 本页导读 (1)