文档中心

函数服务

沙箱实例

CreateSandbox

CreateSandbox

创建沙箱实例。

请求说明

请求方式：POST

请求地址：http://open.volcengineapi.com/?Action=CreateSandbox&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateSandbox	接口名称。当前 API 的名称为 CreateSandbox。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
FunctionId	String	是	wrws****	沙箱实例所属的沙箱应用 ID。在函数服务控制台的云沙箱 > 沙箱应用页面获取沙箱应用 ID。
Timeout	Integer	否	60	沙箱实例存活时长：单位：分钟取值范围：3～1440 默认值为：60
Metadata	JSON Map	否	{"app":"test"}	沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
InstanceTosMountConfig	Object of InstanceTosMountConfig	否	-	沙箱实例级别对象存储（TOS）存储挂载配置。注意若需要配置该参数，请确保实例所属的沙箱应用已配置 TOS 存储挂载。沙箱实例支持在沙箱应用级别 TOS 挂载配置基础之上挂载 TOS 存储桶的不同子目录。
Envs	Array of EnvVar	否	-	沙箱实例环境变量。
InstanceImageInfo	Object of InstanceImageInfo	否	-	沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
CpuMilli	Integer	否	1000	沙箱实例 CPU 规格：单位：milli cpu 取值范围：250~16000 默认值：1000
MemoryMB	Integer	否	2048	沙箱实例内存规格：单位：MiB 取值范围：512~131072 默认值：2048
MaxConcurrency	Integer	否	100	单实例请求最大并发数：取值范围：10~1000 默认值：100
RequestTimeout	Integer	否	30	请求超时时间：单位：秒取值范围：1~900，正整数默认值：30

InstanceTosMountConfig

参数	类型	是否必选	示例值	描述
Enable	Boolean	是	true	沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明： true：是 false：否
TosMountPoints	Array of TosMountPoint	是	-	启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。

EnvVar

参数	类型	是否必选	示例值	描述
Key	String	是	business_type	沙箱实例环境变量的键。
Value	String	是	free	沙箱实例环境变量的值。

InstanceImageInfo

参数	类型	是否必选	示例值	描述
Id	String	否	xGWv9****	沙箱实例使用的已预热镜像 ID。
Port	Integer	是	8080	沙箱实例镜像监听端口。注意请避免使用 veFaaS 占用的端口：9000、9001、9990。
Image	String	否	cr-vefaas-cn-beijing.cr.volces.com/wdf/test/****:latest	沙箱实例使用的已预热镜像地址。
Command	String	是	bash /root/sandbox/scripts/run.sh	沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。

TosMountPoint

参数	类型	是否必选	示例值	描述
BucketPath	String	是	/sandbox	沙箱实例挂载的 TOS 远端目录。
LocalMountPath	String	是	/mnt/tos	沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。

请求示例

返回参数

参数	类型	示例值	描述
SandboxId	String	vefaas-e8m6xarn-p2zamuv2fr-******	沙箱实例的 ID，同时也是沙箱实例的名称。

返回示例

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2025.09.16 14:57:40

这个页面对您有帮助吗？

有用

有用

无用

无用