オンライン編集プロジェクトの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:GetEditingProject |
読み取り |
すべてのリソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
文字列 |
必須 |
オンライン編集プロジェクトの ID です。 |
fb2101bf24b2754cb318787dc |
| RequestSource |
文字列 |
任意 |
リクエストソースの ID です。有効な値: - OpenAPI (デフォルト):タイムライン変換は実行されません。 - WebSDK:この値を指定すると、プロジェクトタイムラインが自動的にフロントエンドスタイルに変換され、タイムライン内の素材がプロジェクトに関連付けられて、フロントエンド Web SDK を使用してプレビューできるようになります。 |
WebSDK |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーターです。 |
||
| RequestId |
文字列 |
リクエスト ID です。 |
63E8B7C7-4812-46AD-0FA56029AC86 |
| Project |
object |
オンライン編集プロジェクトの情報です。 |
|
| ProjectId |
文字列 |
オンライン編集プロジェクトの ID です。 |
fb2101bf24b2754cb318787dc |
| Title |
文字列 |
オンライン編集プロジェクトのタイトルです。 |
Sample title |
| Timeline |
文字列 |
オンライン編集プロジェクトのタイムラインです。 |
{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]} |
| TemplateId |
文字列 |
テンプレート ID です。 |
96e8864746a0b6f3 |
| ClipsParam |
文字列 |
テンプレートに対応する素材パラメーター (JSON 形式) です。TemplateId を指定する場合は、ClipsParam も指定する必要があります。詳細については。 |
テンプレートユーザーガイドを参照してください。 |
| Description |
文字列 |
オンライン編集プロジェクトの説明です。 |
Example description |
| CoverURL |
文字列 |
オンライン編集プロジェクトのサムネイル URL です。 |
http://aaa.bbb/your-cover.jpg |
| CreateTime |
文字列 |
オンライン編集プロジェクトが作成された時刻です。 |
2020-12-20T12:00:00Z |
| ModifiedTime |
文字列 |
オンライン編集プロジェクトが最後に変更された時刻です。 |
2020-12-20T13:00:00Z |
| Duration |
整数 |
オンライン編集プロジェクトの総時間です。 |
24 |
| Status |
文字列 |
オンライン編集プロジェクトのステータスです。有効な値: - Draft - Editing - Producing - Produced - ProduceFailed - Deleted |
Editing |
| CreateSource |
文字列 |
オンライン編集プロジェクトの作成方法です。有効な値: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole |
OpenAPI |
| TemplateType |
文字列 |
オンライン編集プロジェクトのテンプレートタイプです。有効な値: - Timeline - VETemplate |
Timeline |
| ModifiedSource |
文字列 |
オンライン編集プロジェクトの編集方法です。有効な値: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole |
OpenAPI |
| ProjectType |
文字列 |
編集プロジェクトのタイプです。デフォルト値:EditingProject。有効な値: - EditingProject:通常の編集プロジェクト。 - LiveEditingProject:ライブストリーム編集プロジェクト。 |
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 ReservationCanceled BroadCasting LoadingFailed LiveFinished |
Reserving |
| TimelineConvertStatus |
文字列 |
プロジェクト変換ステータスです。API 形式のタイムラインからフロントエンド形式のタイムラインへの変換は非同期で行われ、RequestSource:WebSDK を指定した場合にのみ有効です。 - Unconverted - Converting - Converted - ConvertFailed |
Converted |
| TimelineConvertErrorMessage |
文字列 |
プロジェクト変換が失敗した場合に返されるエラーメッセージです。エラーメッセージには失敗の詳細情報が表示され、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": "サンプルのタイトル",
"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 | 指定されたパラメーターは無効です。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。