Skip to main content

HappyOyster-Directing-查詢 Travel 列表 API 參考

分頁查詢當前主帳號名下的 Directing Travel，可按狀態或關聯 World 篩選。

適用範圍

分頁查詢當前主帳號名下的 Directing Travel，可按狀態或關聯 World 篩選。調用前請確認以下事項：
  • 驗證要求：僅支援 主 API Key 呼叫，臨時 API Key 無法使用（錯誤碼 403003）。
  • 呼叫方：您的伺服器端呼叫。

HTTP 呼叫

  • 新加坡
  • 美国（維吉尼亞）
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels呼叫時請將 {WorkspaceId} 替換為真實的 Workspace 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。
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 （可選）當前主帳號名下的 Directing 加密 World ID。傳入時只返回關聯該 World 的 Travel。本接口自動限定 Directing 模型，不支持 Query 參數 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 表示成功，非 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 狀態查詢單個 Travel。

錯誤碼

如果模型呼叫失敗並返回錯誤訊息，請參閱 HappyOyster 錯誤碼進行解決。

下一步