查询沙盒组信息
请求头(Request Header)
请参考API 使用指南
请求参数(Request Parameters)
| 名称 | 类型 | 必须 | 位置 | 描述 |
|---|---|---|---|---|
| workspace_id | string | 是 | path | 工作空间id,获取方式可以参考快速开始 |
| sandbox_group_id | string | 是 | path | 沙盒组id |
请求示例(Request Example)
curl -L -X GET 'https://sandbox.cn-sh-01.sensecoreapi.cn/studio/sandbox/v1/workspaces/01993ca4-edfa-7382-8161-43a4919681ab/sandboxGroups/5837aaee-c1c6-4293-beec-3b888a004caa' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
响应(Response)
异常情况请参考异常响应说明
| 字段 | 类型 | 描述 |
|---|---|---|
| workspace_id | string | 工作空间ID |
| id | string | 沙盒组 ID |
| name | string | 沙盒组名称 |
| description | string | 沙盒组描述 |
| snapshot | object | 快照信息 |
| state | string | 沙盒实例创建进度: STATE_UPDATING(创建中), STATE_READY(创建结束) |
| volumes | array[object] | 挂载的存储,若未挂载存储,则不返回该字段 |
| environment | object | 环境变量(键值对),若未设置环境变量,则不返回该字段 |
| creator | string | 创建者 |
| updator | string | 更新者 |
| total_instance_count | integer | 沙盒组预期实例数量 |
| running_instance_count | integer | 正常运行中的实例数量 |
| create_time | string | 创建时间 |
| update_time | string | 更新时间 |
| auto_delete_after | integer | 自动删除时长,单位为秒,即从沙盒创建,存活设定时长后系统自动删除该沙盒 。若为不自动删除,则不返回该字段 |
| auto_delete_at | string | 自动删除时间戳。若为不自动删除,则不返回该字段 |
其中,snapshot的参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| workspace_id | string | 工作空间ID |
| id | string | 快照ID |
| name | string | 快照名称 |
| description | string | 快照描述,若为空,则不返回该字段 |
| image | object | 快照所用镜像信息 |
| resource_limits | object | 资源规格设置 |
| command | string | 启动命令,若为空,则不返回该字段 |
其中,image的参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 镜像ID |
| name | string | 镜像名称 |
| type | string | 镜像类型, IMAGE_TYPE_BUILT_IN为预置镜像 |
| description | string | 镜像描述,若为空,则不返回该字段 |
| repository | string | 镜像仓库地址 |
| create_time | string | 镜像创建时间 |
| update_time | string | 镜像更新时间 |
其中,resource_limits的参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| cpu | integer | cpu核数,最小为1核 |
| memory | integer | 内存规格,单位GiB,最小为1GiB |
| storage | integer | 存储规格,单位GiB,最小为1GiB |
其中,volumes每个元素参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| type | string | 卷类型,值可能为VOLUME_TYPE_AFS(挂载文件存储), VOLUME_TYPE_AOSS(挂载对象存储) |
| afs | object | afs文件存储卷信息,当type为VOLUME_TYPE_AFS时不为空 |
| aoss | object | aoss存储桶信息,当type为VOLUME_TYPE_AOSS时不为空 |
其中,afs每个元素参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| volume_id | string | 卷ID |
| source_path | string | NFS 源路径(主机端路径) |
| target_path | string | 容器内挂载路径(目标路径) |
其中,aoss每个元素参数如下:
| 名称 | 类型 | 描述 |
|---|---|---|
| bucket | string | 存储桶名称 |
| endpoint | string | 桶的Endpoint |
| access_key | string | 密钥ID |
| target_path | string | 沙盒内挂载路径 |
| mount_options | string | 挂载高级配置参数,若为空,则不返回该字段 |
响应示例(Response Example)
- 正常响应
{
"workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
"id": "5c12467e-44e4-4074-aba9-1e1fb566edb9",
"name": "sandbox1验收",
"description": "这段文字正好10个字",
"snapshot": {
"workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
"id": "18494045-1b93-4054-b072-d9f8055c32ce",
"name": "最小规格的快照使用",
"image": {
"id": "built_in_image_1",
"name": "registry.sensetime.com/sensecore-higgs/sandbox/bs/code-sandbox:server-20250609",
"type": "IMAGE_TYPE_BUILT_IN",
"create_time": "2025-09-16T09:44:11.338666Z",
"update_time": "2025-09-16T09:44:11.338666Z"
},
"resource_limits": {
"cpu": 1,
"memory": 1,
"storage": 1
},
"creator": "0629ad1a-3784-4754-af90-948032f41322",
"create_time": "2025-09-17T10:46:09.853461Z",
"update_time": "2025-09-17T10:46:09.853461Z"
},
"state": "STATE_READY",
"environment": {
"zjp": "test"
},
"creator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
"updator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
"total_instance_count": 2,
"create_time": "2025-10-14T02:54:16.235272Z",
"update_time": "2025-10-14T02:54:25.510280Z",
"running_instance_count": 2
}