查詢單個雲剪輯工程的資訊。
調試
您可以在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 |
雲剪輯工程標題。 |
樣本title |
| Timeline |
string |
雲剪輯工程時間軸。 |
{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]} |
| TemplateId |
string |
模板 ID |
****96e8864746a0b6f3**** |
| ClipsParam |
string |
模板對應的素材參數,Json 格式,當 TemplateId 不為空白時,ClipsParam 不可為空。具體格式見 普通模板建立及使用、進階模板建立及使用。 |
見模板使用文檔 |
| Description |
string |
雲剪輯工程描述。 |
樣本描述 |
| 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": "樣本title",
"Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
"TemplateId": "****96e8864746a0b6f3****",
"ClipsParam": "見模板使用文檔",
"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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。