全部產品
Search
文件中心

Alibaba Cloud Model Studio:HappyOyster-Adventure-查詢Travel清單 API參考

更新時間:Sep 23, 2026

分頁查詢目前主帳號名下的 Adventure Travel,可按狀態或關聯 World 篩選。

適用範圍

分頁查詢目前主帳號名下的 Adventure Travel,可按狀態或關聯 World 篩選。呼叫前請確認以下事項:

  • 驗證要求:僅支援 主 API Key 呼叫,臨時 API Key 無法使用(錯誤碼 403003)。

  • 呼叫方:您的伺服器端呼叫。

HTTP 呼叫

新加坡

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

华北2(北京)

GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

美国(維吉尼亞)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace 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。

Query 參數

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 Query 參數,模型專屬入口會自動限定為 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 表示成功,非 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 錯誤碼進行解決。

下一步