Qoder Cloud Agents API 列表接口的游标分页规范与遍历示例。
Qoder Cloud Agents API 的列表接口采用 游标分页(Cursor-based Pagination)。默认使用上一页响应中的
所有列表接口返回统一的分页信封:
使用上一页响应中的
部分接口也接受
以下脚本遍历所有 Agents:
当没有数据或已到达末尾时:
next_page 作为下一次请求的 page 参数。游标在数据变动时仍保持稳定。
请求参数
| 参数 | 类型 | 必需 | 默认值 | 说明 |
|---|---|---|---|---|
limit | integer | 否 | 20 | 每页返回数量,范围 1-100 |
page | string | 否 | — | 上一次响应 next_page 返回的不透明游标 |
before_id | string | 否 | — | 兼容游标:返回此 ID 之前的记录 |
after_id | string | 否 | — | 兼容游标:返回此 ID 之后的记录 |
page、before_id 和 after_id 不能同时使用。同时传入多个 cursor 将返回 400 invalid_request_error。响应结构
所有列表接口返回统一的分页信封:
字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data | array | 当前页的资源列表 |
next_page | string | null | 下一页的不透明游标。下一次请求时作为 page 参数传入 |
first_id | string | null | 当前页第一条记录的 ID |
last_id | string | null | 当前页最后一条记录的 ID |
has_more | boolean | 是否还有更多数据 |
基本用法
获取第一页
获取下一页
使用上一页响应中的 next_page 作为 page:
兼容游标
部分接口也接受 before_id 和 after_id 作为基于 ID 的兼容游标:
完整遍历示例
以下脚本遍历所有 Agents:
limit 参数说明
| 值 | 行为 |
|---|---|
| 不传 | 默认返回 20 条 |
| 1 | 最小值,返回 1 条 |
| 100 | 最大值,返回 100 条 |
| 0 或负数 | 返回 400 invalid_request_error,错误消息为 Field 'limit' must be a positive integer. |
| > 100 | 返回 400 invalid_request_error,错误消息为 limit exceeds maximum of 100 |
空结果
当没有数据或已到达末尾时:
注意事项
- 游标稳定性 —
page是不透明游标,应按响应原样传回 - 排序方向 — 默认按创建时间降序(最新在前)
- 兼容游标 —
before_id和after_id作为基于 ID 的兼容游标保留 - 并发安全 — 可安全地在多个客户端间并行分页