查询单个云剪辑工程的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:GetEditingProject |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
string |
是 |
云剪辑工程 ID |
****fb2101bf24b2754cb318787dc**** |
| RequestSource |
string |
否 |
请求来源标识 -OpenAPI:默认,不会做 timeline 转换操作。 -WebSDK:若传入该字段,则会自动将工程 timeline 转换为前端风格,并将 timleine 中关联素材和工程绑定,供前端 websdk 预览。 |
WebSDK |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
****63E8B7C7-4812-46AD-0FA56029AC86**** |
| Project |
object |
云剪辑工程。 |
|
| ProjectId |
string |
云剪辑工程 ID。 |
****fb2101bf24b2754cb318787dc**** |
| Title |
string |
云剪辑工程标题。 |
Sample title |
| Timeline |
string |
云剪辑工程时间线。 |
{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]} |
| TemplateId |
string |
模板 ID |
****96e8864746a0b6f3**** |
| ClipsParam |
string |
模板对应的素材参数,Json 格式,当 TemplateId 不为空时,ClipsParam 不能为空。具体格式见 普通模板创建及使用、高级模板创建及使用。 |
See the template user guide. |
| Description |
string |
云剪辑工程描述。 |
Example description |
| CoverURL |
string |
云剪辑工程封面。 |
http://aaa.bbb/your-cover.jpg |
| CreateTime |
string |
云剪辑工程创建时间。 |
2020-12-20T12:00:00Z |
| ModifiedTime |
string |
云剪辑工程最新修改时间。 |
2020-12-20T13:00:00Z |
| Duration |
integer |
云剪辑工程总时长。 |
24.120000 |
| Status |
string |
云剪辑工程状态。 所有云剪辑工程状态列表: -Draft -Editing -Producing -Produced -ProduceFailed -Deleted |
Editing |
| CreateSource |
string |
云剪辑工程创建方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole |
OpenAPI |
| TemplateType |
string |
云剪辑工程模版类型 -Timeline -VETemplate |
Timeline |
| ModifiedSource |
string |
云剪辑工程编辑方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole |
OpenAPI |
| ProjectType |
string |
剪辑工程类型,默认 EditingProject - EditingProject: 普通剪辑工程 - LiveEditingProject: 直播剪辑工程 |
EditingProject |
| BusinessConfig |
string |
工程业务配置,一般剪辑工程可忽略。 |
{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" } |
| BusinessStatus |
string |
工程业务状态,一般剪辑工程可忽略 预约中:Reserving 预约取消:ReservationCanceled 直播中:BroadCasting 加载失败:LoadingFailed 直播结束:LiveFinished |
Reserving |
| TimelineConvertStatus |
string |
工程转换状态,api 风格 timeline 转换为前端风格 timeline 是一个异步过程,只有在设置 RequestSource:WebSDK 时生效。 -Unconverted:未进行 Timeline 转换 -Converting:工程正在转换中 -Converted:工程转换完成 -ConvertFailed:工程转换失败 |
Converted |
| TimelineConvertErrorMessage |
string |
工程转换失败信息,只有 TimelineConvertStatus 为 ConvertFailed 时返回,工程转换的详细失败信息。 |
The StorageLocation must be in the same division(apiRegion) as ICE service access point. |
示例
正常返回示例
JSON格式
{
"RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
"Project": {
"ProjectId": "****fb2101bf24b2754cb318787dc****",
"Title": "Sample title",
"Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
"TemplateId": "****96e8864746a0b6f3****",
"ClipsParam": "See the template user guide.",
"Description": "Example description",
"CoverURL": "http://aaa.bbb/your-cover.jpg",
"CreateTime": "2020-12-20T12:00:00Z",
"ModifiedTime": "2020-12-20T13:00:00Z",
"Duration": 24.12,
"Status": "Editing",
"CreateSource": "OpenAPI",
"TemplateType": "Timeline",
"ModifiedSource": "OpenAPI",
"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",
"TimelineConvertStatus": "Converted",
"TimelineConvertErrorMessage": "The StorageLocation must be in the same division(apiRegion) as ICE service access point."
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter \ is not valid. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。