分页查询当前主账号名下的 Directing Travel,可按状态或关联 World 筛选。
适用范围
分页查询当前主账号名下的 Directing 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-directing/openapi/v1/travels
调用时请将{WorkspaceId}替换为真实的Workspace ID。
美国(弗吉尼亚)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels
调用时请将{WorkspaceId}替换为真实的Workspace ID。
请求参数 | 查询Travel列表 |
Authorization API Key 鉴权。仅支持主 API Key,以 | |
Query 参数 | |
page 页码,默认 | |
pageSize 每页条数,默认 | |
status 按 Travel 状态筛选。未知值不筛选。可选值:
| |
encryptedWorldId 当前主账号名下的 Directing 加密 World ID。传入时只返回关联该 World 的 Travel。本接口自动限定 Directing 模型,不支持 Query 参数 |
响应参数 | |
code 返回码。 | |
message 错误信息。成功时为 | |
data 响应数据。失败时为 |
前置状态与调用注意事项
- 模型过滤自动生效,
items[].mode恒为2。 - 使用
encryptedWorldId筛选时,该 World 必须属于当前主账号且属于 Directing 模型;其它模型的 World ID 返回403001。 - 进行中的 Travel,其
durationSec和endedAt可以为null。 failed条目额外携带errorCode/errorMessage;其他状态不含这两个字段。在历史列表中展示失败原因时按errorCode分支处理。- 未知
status不会报错,而是按不筛选状态处理;服务端暂停状态请通过查询Travel状态查询单个 Travel。
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
- 查询Travel状态:查询单个 Travel 的实时状态。
- 查询Travel产物:查询已完成 Travel 的视频产物。