Adventure Travel を能動的に終了します。正常終了後は completed になり、ストリームなしタイムアウトによる終了の場合は failed となり、リプレイ成果物は生成されません。maxExperienceTimeSec に達した場合も、サーバーによって自動的に終了されます。
スコープ
Adventure Travel を能動的に終了します。正常終了後、Travel は completed になります。ストリームなしタイムアウトによる終了の場合は failed になります。呼び出し前に、以下を確認してください。
- 認証:プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
- 前提条件:Travel はまだ終端状態に入っておらず、サーバーが終了できる状態である必要があります。Travel ステータスのクエリ で確認してください。
- 呼び出し元:サーバーまたはクライアントのいずれからも呼び出すことができます。
HTTP リクエスト
Singapore
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
{WorkspaceId} を実際の ワークスペースID に置き換えます。
中国(北京)
POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
{WorkspaceId} を実際の ワークスペースID に置き換えます。
米国(バージニア)
POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
{WorkspaceId} を実際の ワークスペースID に置き換えます。
リクエストパラメーター | 正常終了ストリームなしタイムアウト終了 |
Content-Type リクエストのコンテンツタイプ。このパラメータは | |
Authorization API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
| |
リクエストボディ | |
encryptedTravelId 終了対象の Adventure 暗号化 Travel ID です。Travel への入室 によって返されます。 | |
failCode ストリームなしタイムアウトによる失敗終了の理由です。省略した場合は正常終了として扱われます。現在サポートされているのは次のみです:
サポートされていない値を渡すと | |
userAgent SDK またはクライアントのバージョン識別子です。空でない文字列であり、HTTP |
レスポンスパラメーター | 正常終了ストリームなしタイムアウト終了 |
code リターンコード。 | |
message エラーメッセージ。成功時は | |
data レスポンスデータ。失敗時は |
前提条件となるステータスと呼び出しに関する注意事項
encryptedTravelIdは現在のプライマリアカウントおよび Adventure モデルに属している必要があります。failCodeを省略した場合、正常終了として扱われます。サポートされていない値を渡すと400000が返されます。maxExperienceTimeSecに達すると、サーバーは自動的に Travel を終了します。クライアントは、ステータスコールバックまたはステータス照会結果からローカル状態を収束させる必要があります。- 正常終了時、
durationSecは優先的に利用可能な完成動画の実際の長さを使用します。完成動画の長さをまだ解析できない場合はnullになることがあります。 - 正常終了後に
completedに達しても、合成済みアーティファクトはまだ処理中の可能性があります。Travel アーティファクトのクエリ に従ってクエリおよびポーリングを行ってください。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
Travel が completed 状態になった後:
- Travel アーティファクトのクエリ:ポーリングして、記録されたオリジナルおよび合成済みバリアントを取得します。
- Travel リストのクエリ:過去の Travel を表示します。