列出沙箱实例
更新时间:2026-11-17
接口描述
列出当前账号下所有运行中(running)的沙箱实例,不分页,支持按 metadata 过滤(E2B v1 兼容)。不返回已暂停的沙箱;默认不返回由平台托管的沙箱(metadata 含 baidubce_managedBy),在 metadata 过滤条件中显式指定 baidubce_managedBy 时才返回。需要分页或查询已暂停沙箱请使用“分页列出沙箱实例”或“批量查询沙箱实例”接口。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,运行成功后可自动生成 SDK 代码示例。
请求结构
Plain Text
1GET /sandboxes HTTP/1.1
2Host: api.sandbox-execute.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域。Authorization 支持 IAM API Key(Bearer bce-v3/ALTAK-...)或 AK/SK 签名(bce-auth-v1/...)。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| metadata | String | 否 | Query参数 | metadata 过滤条件,格式为 URL 编码后的 key=value&key2=value2,例如 app%3Dagent%26env%3Dtest,多个条件之间为 AND。 |
返回状态码
成功返回 200。服务端查询失败返回 500(Failed to list sandboxes);认证失败返回 403。该接口受服务端访问控制与限流保护,被拒绝时返回 403(AccessDeniedException)或 429(TooManyRequestsException,带 Retry-After)。
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| sandboxes | List |
注意:响应体本身就是 ListedSandbox 数组(JSON 数组,没有外层对象),sandboxes 只是本表的占位名称,请按响应示例解析。 |
请求示例
Plain Text
1GET /sandboxes?metadata=app%3Dagent HTTP/1.1
2Host: api.sandbox-execute.bj.baidubce.com
3Authorization: authorization string
响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json
3
4[
5 {
6 "sandboxID": "sandbox-1",
7 "templateID": "openclaw-lite",
8 "alias": "openclaw-lite",
9 "clientID": "",
10 "state": "running",
11 "cpuCount": 2,
12 "memoryMB": 2048,
13 "diskSizeMB": 10240,
14 "startedAt": "2026-11-16T14:00:00+08:00",
15 "endAt": "2026-11-16T15:00:00+08:00",
16 "envdVersion": "0.1.4"
17 }
18]
评价此篇文章
