获取沙盒组下沙盒实例列表 | 大装置帮助中心
跳到主要内容

获取沙盒组下沙盒实例列表

GET https://sandbox.cn-sh-01.sensecoreapi.cn/studio/sandbox/v1/workspaces/{workspace_id}/sandboxGroups/{sandbox_group_id}/sandboxes

请求头（Request Header）​

请参考API 使用指南

请求参数（Request Parameters）​

名称类型必须位置描述
workspace_idstring是path工作空间id，获取方式可以参考快速开始
sandbox_group_idstring是path沙盒组id
filterstring否query过滤条件
order_bystring否query排序,例:"create_time desc, name".
page_sizeinteger否query返回当前页的最大条目数.
page_tokenstring否query从上一个List请求返回的next_page_token值(如果有的话).

请求示例（Request Example）​

curl -L -X GET 'https://sandbox.cn-sh-01.sensecoreapi.dev/studio/sandbox/v1/workspaces/01993ca4-edfa-7382-8161-43a4919681ab/sandboxGroups/5837aaee-c1c6-4293-beec-3b888a004caa/sandboxes' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

响应（Response）​

异常情况请参考异常响应说明

名称类型描述
sandboxesarray[object]已有的沙盒列表
next_page_tokenstring下一页的token.
total_sizeinteger沙盒资源总数.

其中sandboxes的参数如下：

名称类型描述
workspace_idstring工作空间ID
idstring沙盒ID
namestring沙盒名称
descriptionstring沙盒描述
snapshotobject该沙盒所用快照信息
statestring沙盒状态,STATE_RUNNING为正常运行中, STATE_FAILED为沙盒异常
volumesarray[object]挂载的存储,若未挂载存储，则不返回该字段
environmentobject环境变量（键值对），若未设置环境变量，则不返回该字段
creatorstring创建者
updatorstring更新者
cluster_idstring运行的节点名称
create_timestring创建时间
update_timestring更新时间
auto_delete_afterinteger自动删除时长，单位为秒，即从沙盒创建，存活设定时长后系统自动删除该沙盒。若为不自动删除，则不返回该字段
auto_delete_atstring自动删除时间戳。若为不自动删除，则不返回该字段
next_page_tokenstring下一页的token.
total_sizeinteger镜像资源总数.

其中，snapshot的参数如下：

名称类型描述
workspace_idstring工作空间ID
idstring快照ID
namestring快照名称
descriptionstring快照描述，若为空，则不返回该字段
imageobject快照所用镜像信息
resource_limitsobject资源规格设置
commandstring启动命令
creatorstring创建者
updatorstring更新者
create_timestring创建时间
update_timestring更新时间

其中，image的参数如下：

名称类型描述
idstring镜像ID
namestring镜像名称
typestring镜像类型, IMAGE_TYPE_BUILT_IN为预置镜像
descriptionstring镜像描述，若为空，则不返回该字段
repositorystring镜像仓库地址
create_timestring镜像创建时间
update_timestring镜像更新时间

其中，resource_limits的参数如下：

名称类型描述
cpuintegercpu核数，最小为1核
memoryinteger内存规格，单位GiB，最小为1GiB
storageinteger存储规格，单位GiB，最小为1GiB

其中,volumes每个元素参数如下：

名称类型描述
typestring卷类型，值可能为 VOLUME_TYPE_AFS（挂载文件存储）, VOLUME_TYPE_AOSS（挂载对象存储）
afsobjectafs文件存储卷信息，当type为VOLUME_TYPE_AFS时不为空
aossobjectaoss存储桶信息，当type为VOLUME_TYPE_AOSS时不为空

其中,afs每个元素参数如下：

名称类型描述
volume_idstring卷ID
source_pathstringNFS 源路径（主机端路径）
target_pathstring容器内挂载路径（目标路径）

其中，aoss每个元素参数如下：

名称类型描述
bucketstring存储桶名称
endpointstring桶的Endpoint
access_keystring密钥ID
target_pathstring沙盒内挂载路径
mount_optionsstring挂载高级配置参数，若为空，则不返回该字段

响应示例（Response Example）​

  • 正常响应
{
    "sandboxes": [
        {
            "workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
            "id": "a4e37759-42a6-4578-bcd2-7e3e2db40b4f",
            "name": "1ve4yp8ac7etahkqhzng",
            "description": "这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字",
            "snapshot": {
                "workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
                "id": "18494045-1b93-4054-b072-d9f8055c32ce",
                "name": "最小规格的快照使用_1_1_1用于性能测试也不要删除命名长一点就是一个显眼包了不要删除",
                "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_RUNNING",
            "environment": {
                "zjp": "test"
            },
            "creator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
            "updator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
            "create_time": "2025-10-14T02:54:25.395641Z",
            "update_time": "2025-10-14T02:54:25.395641Z"
        },
        {
            "workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
            "id": "5d3890e6-1d3f-4679-a55d-8d0aba44c6e3",
            "name": "2s4iohr9vgrbps70ghun",
            "description": "这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字这段文字正好10个字",
            "snapshot": {
                "workspace_id": "01995733-e3da-7635-99ae-f1acf14364c4",
                "id": "18494045-1b93-4054-b072-d9f8055c32ce",
                "name": "最小规格的快照使用_1_1_1用于性能测试也不要删除命名长一点就是一个显眼包了不要删除",
                "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_RUNNING",
            "environment": {
                "zjp": "test"
            },
            "creator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
            "updator": "ca71ed1d-9b26-49e5-be96-b2da449d5a94",
            "create_time": "2025-10-14T02:54:20.480093Z",
            "update_time": "2025-10-14T02:54:20.480093Z"
        }
    ],
    "total_size": 2
}