すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud Model Studio:HappyOyster-Directing-Query Travel List APIリファレンス

最終更新日:Sep 23, 2026

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

スコープ

現在のプライマリアカウント配下のDirecting 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-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リストのクエリ

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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 (任意)

現在のプライマリアカウント配下のDirecting暗号化済みWorld IDです。指定した場合、そのWorldのTravelのみが返されます。このエンドポイントは結果を自動的にDirectingモデルに限定し、modeクエリパラメータはサポートしていません。

レスポンスパラメーター

{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 180,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:03:00Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": "2026-06-03T11:03:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

items array

現在のページのTravel一覧。結果がない場合は空の配列です。各項目にはencryptedTravelId、status、mode(常に2)、encryptedWorldId、durationSec(実行中または最終カットが未準備の場合はnull)、createdAt、およびendedAt(実行中の場合はnull)が含まれます。

pagination object

ページネーション情報です。page、pageSize、total、hasMoreを含みます。

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

  • モデルフィルターは自動的に有効になり、items[].modeは常に2です。
  • encryptedWorldIdでフィルタリングする場合、そのWorldは現在のプライマリアカウントおよびDirectingモデルに属している必要があります。別のモデルのWorld IDを指定すると403001が返されます。
  • 実行中のTravelの場合、durationSecとendedAtはnullになることがあります。
  • 不明なstatusはエラーを引き起こさず、ステータスフィルターなしとして扱われます。サーバー側の一時停止ステータスについては、Travel Statusのクエリを通じて単一のTravelをクエリしてください。

エラーコード

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

次のステップ