完了した Acting Travel の記録済みオリジナルと3つの合成バリアントをクエリします。外部への配信には withInstructionAndWatermark を推奨します。
スコープ
完了した Acting Travel の記録済みオリジナルと3つの合成バリアントをクエリします。withInstruction はユーザーのプロセス指示のオーバーレイバリアントです。外部への配信には withInstructionAndWatermark を推奨します。呼び出す前に、以下を確認してください。
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
前提条件:Travelのステータスが
completedであること。利用可能なオリジナルURLがアーティファクトレスポンスを返すための前提条件となります。Query Travel Statusで確認してください。 -
Caller:サーバーから呼び出されます。
HTTP リクエスト
Singapore
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts
{WorkspaceId} を実際の ワークスペースID に置き換えます。
米国(バージニア)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts
{WorkspaceId} を実際の ワークスペースID に置き換えます。
リクエストパラメーター | Travelアーティファクトのクエリ |
Authorization API Key 認証。プライマリ API Key のみがサポートされており、 | |
クエリパラメータ | |
encryptedTravelId ステータスが |
レスポンスパラメーター | 4つのアーティファクトすべてが準備完了合成処理中 |
code リターンコード。 | |
message エラーメッセージ。成功時は | |
data レスポンスデータ。失敗時は |
前提条件となるステータスと呼び出しに関する注意事項
- クライアントは、
composeStatus != readyの間、制御された間隔でポーリングできます。 video.withInstructionは処理指示オーバーレイバリアントであり、指示なしのオリジナルではありません。- 外部配信の場合は
video.withInstructionAndWatermarkを参照してください。ビジネスでオリジナルのみが必要な場合は、引き続きvideo.original.urlを参照してください。 - 4つのビデオバリアントは同じ再生時間解析結果を共有するため、1つのレスポンス内で解析可能な再生時間を持つ準備完了のバリアントは一貫した
durationSecを返します。 TRAVEL_NO_STREAM_AUTO_ENDによって終了されたTravelはfailedとなり、クエリ可能なアーティファクトを生成しません。404000を常に「未完了」としてレンダリングしないでください。まず Query Travel Status または Query Travel List を通じてstatusとerrorCodeを読み取ってください。failedの Travel については、失敗理由を表示してください。
404000 シナリオ
| シナリオ | エンドポイントの動作 |
|---|---|
Travelがまだ進行中(init / pending / running / paused) | ビジネスコード 404000を返します( message = Video is still being generated, please try again once the process is complete |
Travelが failed | ビジネスコード 404000を返します( message = Experience failed and no video was produced (errorCode=<errorCode>): <errorMessage>。失敗は終端状態であり、動画は生成されません |
| Travelが存在しない、自分のものではない、またはActingではない | ビジネスコード 404000 |
| オリジナルURLが利用不可 | ビジネスコード 404000。オリジナルはエンドポイント全体のハードゲートです |
| オリジナルは準備完了だが合成はまだ処理中 | HTTP 200。対応する合成アイテムは status=processing, url=null |
| 合成に失敗したか、URLが一時的に利用不可 | HTTP 200。対応する合成アイテムは status=unavailable, url=null |
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- Query Travel List:他の過去のTravelを表示します。
- End Travel:アーティファクトをクエリする前に新しいTravelを終了します。