Skip to main content

HappyOyster-Acting-Query Travel List APIリファレンス

現在のプライマリアカウント配下のActing Travelをページネーションし、ステータスまたは関連するWorldでオプションのフィルタリングを行います。

スコープ

現在のプライマリアカウント配下のActing Travelをページネーションし、ステータスまたは関連するWorldでオプションのフィルタリングを行います。呼び出す前に、以下を確認してください。
  • 認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
  • Caller：サーバーから呼び出されます。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Travelリストのクエリ
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string （必須）API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります（例：sk-xxx）。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key（st- で始まる）を使用すると 403003 が返されます。
クエリパラメータ
page integer （任意）ページ番号です。デフォルトは1です。page <= 0の場合は1として扱われます。
pageSize integer （任意）ページあたりの項目数で、デフォルトは20です。pageSize <= 0の場合は20として扱われ、100を超える場合は100に制限されます。
status string （任意）Travelステータスでフィルタリングします。不明な値はフィルタとして適用されません。許可される値は以下の通りです。
  • init：セッションリソースを初期化中
  • pending：キューに入っているか、サービスリソースを待機中
  • running：実行中
  • failed：Travelが失敗しました。理由についてはerrorCode／errorMessageを参照してください
  • completed：Travelが終了しました。アーティファクトをクエリできます
encryptedWorldId string （任意）現在のプライマリアカウント配下のActing World IDです。指定した場合、そのWorldのTravelのみが返されます。このエンドポイントはmodeクエリパラメータをサポートしていません。モデル固有のエントリーにより、結果は自動的にActingに限定されます。

レスポンスパラメーター

  • クエリ成功
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 180,
                "createdAt": "2026-09-09T08:10:00Z",
                "endedAt": "2026-09-09T08:13:00Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "running",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-09-09T09:10:00Z",
                "endedAt": null
            },
            {
                "encryptedTravelId": "trvl_m3n4****",
                "status": "failed",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-09-09T10:10:00Z",
                "endedAt": "2026-09-09T10:10:05Z",
                "errorCode": "TRAVEL_SESSION_INIT_FAILED",
                "errorMessage": "Failed to allocate inference resources."
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 3,
            "hasMore": false
        }
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

items array現在のページの Travel です。結果がない場合は空の配列になります。各項目には encryptedTravelId、status、mode（常に 3）、encryptedWorldId、durationSec（実行中、失敗時、または再生時間が利用できない場合は null）、createdAt、および endedAt（まだ実行中の場合は null）が含まれます。status=failed の項目には追加で errorCode（構造化された失敗理由。値については Query Travel Status を参照）および errorMessage（英語の説明）が含まれます。他のステータスの項目にはこれら2つのキーは含まれません。pagination objectページネーション情報です。page、pageSize、total、hasMoreを含みます。

前提条件となるステータスと呼び出しに関する注意事項

  • このエンドポイントはActing Travelのみを自動的に返し、items[].modeは常に3です。
  • encryptedWorldIdでフィルタリングする場合、そのWorldは現在のプライマリアカウントおよびActingモデルに属している必要があります。別のモデルのWorldの場合は403001が返されます。
  • 実行中のTravelの場合、durationSecとendedAtは通常nullです。
  • failed の項目には追加で errorCode / errorMessage が含まれます。他のステータスの項目にはこれら2つのキーは含まれません。履歴リストに失敗理由を表示する際は、errorCode に基づいて分岐してください。
  • 不明なstatusはエラーを引き起こさず、ステータスフィルタなしとして扱われます。単一のTravelのリアルタイムpausedステータスをクエリするには、Query Travel Statusを使用してください。
  • 空の結果はエラーではありません。items=[]と対応するページネーション情報が返されます。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ