更新沙盒组信息

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

请求头（Request Header）

请参考API 使用指南

请求参数（Request Parameters）

名称	类型	必须	位置	描述
workspace_id	string	是	path	工作空间id，获取方式可以参考快速开始
sandbox_group_id	string	是	path	沙盒组id
name	string	否	body	沙盒组名称，支持中文英文数字，不超过30字符
description	string	否	body	沙盒描述
auto_delete_after	integer	否	body	自动删除时长，单位为秒，即从沙盒创建，存活设定时长后系统自动删除该沙盒，取值范围为-1或者[300,86400],默认值为86400，即默认24小时后删除该沙盒，传入-1则沙盒一直保留，不自动删除

请求示例（Request Example）

curl -L -X PATCH 'https://sandbox.cn-sh-01.sensecoreapi.dev/studio/sandbox/v1/workspaces/01993ca4-edfa-7382-8161-43a4919681ab/sandboxGroups/c9111309-2537-44e7-ad33-0fcb63755222' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name":"test111",
  "description":"www",
  "auto_delete_after":300
}'

响应（Response）

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

字段	类型	描述
workspace_id	string	工作空间ID
id	string	沙盒组 ID
name	string	沙盒组名称
description	string	沙盒组描述
snapshot	object	快照信息
state	string	沙盒组状态：STATE_UNSPECIFIED, STATE_INITIALIZING, STATE_RUNNING, STATE_FAILED
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": "01993ca4-edfa-7382-8161-43a4919681ab",
    "id": "c9111309-2537-44e7-ad33-0fcb63755222",
    "name": "test111",
    "snapshot": {
        "workspace_id": "01993ca4-edfa-7382-8161-43a4919681ab",
        "id": "abb5331c-157b-42f1-928b-9d58a3271e5e",
        "name": "4523",
        "image": {
            "id": "built_in_image_1",
            "name": "vemlp-cn-beijing.cr.volces.com/preset-images/code-sandbox:server-20250609",
            "type": "IMAGE_TYPE_BUILT_IN",
            "create_time": "2025-09-12T06:24:36.918629Z",
            "update_time": "2025-09-12T06:24:36.918629Z"
        },
        "resource_limits": {
            "cpu": 1,
            "memory": 3,
            "storage": 4
        },
        "creator": "f97e5bc3-fbc4-4b9a-8d4b-7207bd4e3e1e",
        "create_time": "2025-10-10T02:53:27.711061Z",
        "update_time": "2025-10-10T02:53:27.711061Z"
    },
    "state": "STATE_READY",
    "creator": "f97e5bc3-fbc4-4b9a-8d4b-7207bd4e3e1e",
    "updator": "f97e5bc3-fbc4-4b9a-8d4b-7207bd4e3e1e",
    "total_instance_count": 1,
    "create_time": "2025-10-13T07:52:19.301472Z",
    "update_time": "2025-10-13T07:59:05.189653Z",
    "auto_delete_at": "2025-10-14T07:52:25.500136Z",
    "running_instance_count": 1
}