現在のプライマリアカウント配下のDirecting Travelをページネーション取得します。ステータスまたは関連するWorldによるオプションのフィルタリングが可能です。
スコープ
現在のプライマリアカウント配下のDirecting Travelをページネーション取得します。ステータスまたは関連するWorldによるオプションのフィルタリングが可能です。呼び出し前に、以下を確認してください:
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
Caller:サーバーから呼び出されます。
HTTP リクエスト
Singapore
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels
{WorkspaceId} を実際の ワークスペースID に置き換えます。
米国(バージニア)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels
{WorkspaceId} を実際の ワークスペースID に置き換えます。
リクエストパラメーター | Travelリストのクエリ |
Authorization API Key 認証。プライマリ API Key のみがサポートされており、 | |
クエリパラメータ | |
page ページ番号です。デフォルトは | |
pageSize ページあたりの項目数で、デフォルトは | |
status Travelステータスでフィルタリングします。不明な値はフィルタとして適用されません。許可される値は以下の通りです。
| |
encryptedWorldId 現在のプライマリアカウント配下のDirecting暗号化済みWorld IDです。指定した場合、そのWorldのTravelのみが返されます。このエンドポイントは結果を自動的にDirectingモデルに限定し、 |
レスポンスパラメーター | |
code リターンコード。 | |
message エラーメッセージ。成功時は | |
data レスポンスデータ。失敗時は |
前提条件となるステータスと呼び出しに関する注意事項
- モデルフィルターは自動的に有効になり、
items[].modeは常に2です。 encryptedWorldIdでフィルタリングする場合、そのWorldは現在のプライマリアカウントおよびDirectingモデルに属している必要があります。別のモデルのWorld IDを指定すると403001が返されます。- 実行中のTravelの場合、
durationSecとendedAtはnullになることがあります。 - 不明な
statusはエラーを引き起こさず、ステータスフィルターなしとして扱われます。サーバー側の一時停止ステータスについては、Travel Statusのクエリを通じて単一のTravelをクエリしてください。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- Query Travel Status:単一のTravelのリアルタイムステータスをクエリします。
- Query Travel Artifacts:完了したTravelの動画アーティファクトをクエリします。