连接沙箱实例
更新时间:2026-11-17
接口描述
连接沙箱实例并续期。沙箱运行中时仅更新超时时间;沙箱已暂停时自动恢复;沙箱已通过“批量释放沙箱实例”释放时,按原 sandboxID 重新创建实例。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,运行成功后可自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /sandboxes/{sandboxID}/connect HTTP/1.1
2Host: api.sandbox-execute.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
请求头域
除公共头域外,无其他特殊头域。Authorization 支持 IAM API Key(Bearer bce-v3/ALTAK-...)或 AK/SK 签名(bce-auth-v1/...)。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| sandboxID | String | 是 | URL参数 | 沙箱实例 ID。 |
| timeout | Integer | 是 | RequestBody参数 | 从当前时间起的存活时间,单位秒;大于 0 或 -1(永久沙箱),大于 0 时不超过 604800。 |
| snapshotID | String | 否 | RequestBody参数 | 恢复暂停沙箱时指定使用的快照 ID(可通过“查询沙箱快照列表”获取),仅对已暂停沙箱生效。 |
| volumeMounts | List |
否 | RequestBody参数 | 仅在恢复暂停沙箱时生效:不传沿用原挂载;传空数组清空挂载;非空则全量替换挂载集合,最多 10 个。沙箱运行中时携带该字段返回 400,运行中追加挂载请使用动态挂载接口。 |
返回状态码
仅续期运行中的沙箱返回 200;恢复了暂停沙箱或重建了已释放沙箱返回 201。timeout 为 0 或小于 -1 返回 400;沙箱不存在返回 404;认证失败返回 403。
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| sandboxID | String | 沙箱实例 ID。 |
| templateID | String | 模板 ID。 |
| alias | String | 模板别名。 |
| clientID | String | 客户端 ID,已废弃,固定为空字符串。 |
| domain | String | 沙箱访问根域名。 |
| envdAccessToken | String | envd 访问令牌。 |
| envdVersion | String | envd 版本号。 |
| mountedVolumePaths | List |
请求携带 volumeMounts 时返回,本次连接后沙箱上实际已挂载的容器内路径(含原本已挂载的路径)。 |
| volumeMountError | String | 请求携带 volumeMounts 且部分挂载失败时返回失败原因。续期本身已生效,因此不以错误状态码返回。 |
请求示例
Plain Text
1POST /sandboxes/sandbox-1/connect HTTP/1.1
2Host: api.sandbox-execute.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "timeout": 3600
8}
响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json
3
4{
5 "sandboxID": "sandbox-1",
6 "templateID": "openclaw-lite",
7 "alias": "openclaw-lite",
8 "clientID": "",
9 "domain": "sandbox-execute.bj.baidubce.com",
10 "envdAccessToken": "xxxxxxxx",
11 "envdVersion": "0.1.4"
12}
评价此篇文章
