分页查询当前主账号名下的 Acting Travel,可按状态或关联 World 筛选。
适用范围
分页查询当前主账号名下的 Acting 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-acting/openapi/v1/travels调用时请将{WorkspaceId}替换为真实的Workspace ID。请求参数 |
|
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 状态筛选。未知值不筛选。可选值:
| |
encryptedWorldId string (可选)当前主账号名下的 Acting World ID。传入时仅返回该 World 的 Travel。本接口不支持 mode Query 参数,模型专属入口会自动限定为 Acting。 |
响应参数 |
|
code integer返回码。0 表示成功,非 0 为错误码。 | |
message string错误信息。成功时为 null。 | |
data object响应数据。失败时为 null。
属性 items array当前页 Travel 列表;无结果时为空数组。每项含 encryptedTravelId、status、mode(恒为 3)、encryptedWorldId、durationSec(进行中、失败或时长尚不可用时为 null)、createdAt、endedAt(进行中时为 null);status=failed 的条目额外携带 errorCode(结构化失败原因,取值见查询Travel状态)和 errorMessage(英文说明),其它状态没有这两个键。pagination object分页信息。含 page、pageSize、total、hasMore。 |
前置状态与调用注意事项
- 接口自动只返回 Acting Travel,
items[].mode恒为3。 - 使用
encryptedWorldId筛选时,该 World 必须属于当前主账号和 Acting 模型;其它模型的 World 返回403001。 - 进行中 Travel 的
durationSec和endedAt通常为null。 failed条目额外携带errorCode/errorMessage,其它状态的条目没有这两个键;历史列表展示失败原因时以errorCode为准。- 未知
status不会报错,而是按不筛选状态处理;查询单个 Travel 的实时paused状态应使用查询Travel状态。 - 空结果不是错误,返回
items=[]和对应分页信息。
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
- 查询Travel状态:查询单个 Travel 的实时状态。
- 查询Travel产物:查询已完成 Travel 的视频产物。