オンライン編集プロジェクトの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:GetEditingProject |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
string |
必須 |
オンライン編集プロジェクトの ID です。 |
****fb2101bf24b2754cb318787dc**** |
| RequestSource |
string |
任意 |
リクエスト元の ID です。有効な値は以下のとおりです。 - OpenAPI(デフォルト):タイムライン変換は実行されません。 - WebSDK:この値を指定すると、プロジェクトのタイムラインがフロントエンド形式に自動的に変換され、タイムライン内の素材がプロジェクトに関連付けられて、フロントエンド Web SDK を使用したプレビューが可能になります。 |
WebSDK |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーターです。 |
||
| 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 |
オンライン編集プロジェクトのサムネイル URL です。 |
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 形式のタイムラインからフロントエンド形式のタイムラインへの変換は非同期プロセスであり、RequestSource:WebSDK を指定した場合のみ有効になります。 - Unconverted - Converting - Converted - ConvertFailed |
Converted |
| TimelineConvertErrorMessage |
string |
プロジェクトの変換に失敗した場合に返されるエラーメッセージです。このメッセージには失敗の詳細情報が含まれており、TimelineConvertStatus の値が `ConvertFailed` の場合にのみ返されます。 |
The StorageLocation must be in the same division(apiRegion) as ICE service access point. |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter \ is not valid. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。