获取当前账号下所有 Session 的列表,支持分页。
完整分页规范详见 分页。
HTTP 200 OK
将响应中的
完整错误信封说明详见 错误参考。
GET /api/v1/cloud/sessions
请求头
| 头部 | 必选 | 说明 |
|---|---|---|
Authorization | 是 | Bearer |
查询参数
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
limit | integer | 否 | 最大返回数量。默认 20,范围 1-100。超过 100 返回 400 invalid_request_error |
page | string | 否 | 上一次响应 next_page 返回的不透明游标 |
order | string | 否 | 排序方向:desc(默认)或 asc |
include_archived | boolean | 否 | 是否包含已归档 Sessions |
statuses | string 或 array | 否 | 按 Session 生命周期状态过滤。允许值:running、idle、rescheduling、terminated。归档 Session 通过 include_archived 单独过滤 |
agent_id | string | 否 | 按 Agent ID 过滤 |
agent_version | integer | 否 | 按 Agent 版本过滤 |
deployment_id | string | 否 | 按 Deployment ID 过滤 |
memory_store_id | string | 否 | 筛选挂载了指定 Memory Store 的 Sessions |
created_at[gt] | string | 否 | 返回创建时间晚于该 RFC 3339 时间的 Sessions |
created_at[gte] | string | 否 | 返回创建时间不早于该 RFC 3339 时间的 Sessions |
created_at[lt] | string | 否 | 返回创建时间早于该 RFC 3339 时间的 Sessions |
created_at[lte] | string | 否 | 返回创建时间不晚于该 RFC 3339 时间的 Sessions |
示例请求
示例响应
HTTP 200 OK
响应字段
字段 | 类型 | 说明 |
| array | Session 对象列表 |
| string | 当前页第一条记录的 ID |
| string | 当前页最后一条记录的 ID |
| boolean | 当前结果集之后还有更多页时为 |
| string | null | 下一页的不透明游标,无更多结果时为 |
next_page 作为下一次请求的 page 参数实现翻页。
错误码
| HTTP | type | 触发条件 |
|---|---|---|
| 400 | invalid_request_error | 分页或过滤参数无效 |
| 401 | authentication_error | PAT 无效或过期 |