分頁查詢目前主帳號名下的 Adventure Travel,可按狀態或關聯 World 篩選。
適用範圍
分頁查詢目前主帳號名下的 Adventure Travel,可按狀態或關聯 World 篩選。呼叫前請確認以下事項:
-
驗證要求:僅支援 主 API Key 呼叫,臨時 API Key 無法使用(錯誤碼
403003)。- 取得主 API Key:取得與設定 API Key。
-
呼叫方:您的伺服器端呼叫。
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列表 |
Authorization API Key 驗證。僅支援主 API Key,以 | |
Query 參數 | |
page 頁碼,預設 | |
pageSize 每頁筆數,預設 | |
status 按 Travel 狀態篩選。未知值不篩選。可選值:
| |
encryptedWorldId 目前主帳號名下的 Adventure World ID。傳入時僅返回該 World 的 Travel。本介面不支援 |
回應參數 | 查詢成功 |
code 返回碼。 | |
message 錯誤訊息。成功時為 | |
data 回應資料。失敗時為 |
前置狀態與呼叫注意事項
- 介面自動只返回 Adventure Travel,
items[].mode恆為1。 - 使用
encryptedWorldId篩選時,該 World 必須屬於目前主帳號和 Adventure 模型;其它模型的 World 返回403001。 - 進行中 Travel 的
durationSec和endedAt通常為null。 - 未知
status不會報錯,而是按不篩選狀態處理。 - 空結果並非錯誤,返回
items=[]和對應分頁資訊。
錯誤碼
如果模型呼叫失敗並返回錯誤訊息,請參閱 HappyOyster 錯誤碼進行解決。
下一步
- 查詢Travel狀態:查詢單一 Travel 的即時狀態。
- 查詢Travel產物:查詢已完成 Travel 的影片產物。