Skip to main content

HappyOyster-Adventure-旅行リストAPIリファレンス

現在のプライマリアカウント配下のAdventure旅行をページネーションで取得します。ステータスまたは関連するWorldによるフィルタリングも可能です。

スコープ

現在のプライマリアカウント配下の Adventure 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-adventure/openapi/v1/travels{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Travelリストのクエリ
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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 が失敗しました。
  • completed：Travelが終了しました。アーティファクトをクエリできます
encryptedWorldId string （任意）現在のプライマリアカウント配下の Adventure World ID です。指定した場合、その World の Travel のみが返されます。このエンドポイントは mode クエリパラメータをサポートしていません。モデル固有のエントリーにより、結果は自動的に Adventure に限定されます。

レスポンスパラメーター

  • クエリ成功
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 90,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:01:30Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "running",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": null
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

items array現在のページの Travel。結果がない場合は空の配列です。各項目には encryptedTravelId、status、mode（常に 1）、encryptedWorldId、durationSec（実行中、失敗時、または期間が未確定の場合は null）、createdAt、および endedAt（実行中の場合は null）が含まれます。pagination objectページネーション情報です。page、pageSize、total、hasMoreを含みます。

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

  • このエンドポイントは Adventure Travel のみを自動的に返し、items[].mode は常に 1 です。
  • encryptedWorldId でフィルタリングする場合、その World は現在のプライマリアカウントおよび Adventure モデルに属している必要があります。別のモデルの World を指定すると 403001 が返されます。
  • 実行中のTravelの場合、durationSecとendedAtは通常nullです。
  • 不明な status はエラーを引き起こさず、ステータスフィルタなしとして扱われます。
  • 空の結果はエラーではありません。items=[]と対応するページネーション情報が返されます。

エラーコード

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

次のステップ