查询沙箱实例详情。

请求说明

请求方式：POST

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeSandbox	接口名称。当前 API 的名称为 DescribeSandbox。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
SandboxId	String	是	vefaas-fnhyb3lm-ku58oo12ls-****	沙箱实例 ID/名称。在函数服务控制台的云沙箱 > 沙箱应用页面，具体沙箱应用的沙箱实例页签下获取沙箱实例 ID/名称。
FunctionId	String	是	fnhy****	沙箱实例所在沙箱应用的 ID。在函数服务控制台的云沙箱 > 沙箱应用页面获取沙箱应用 ID。

请求示例

返回参数

参数	类型	示例值	描述
Id	String	vefaas-fnhyb3lm-ku58oo12ls-****	沙箱实例 ID/名称。
FunctionId	String	fnhy****	沙箱实例所在沙箱应用的 ID。
Metadata	JSON Map	{"app":"test"}	沙箱实例 Label 元信息。
CreatedAt	String	2025-04-25 11:11:29.376 +0000 UTC	沙箱实例创建时间。
ExpireAt	String	2025-04-25 11:31:29.376 +0000 UTC	沙箱实例存活时长。
Status	String	Ready	沙箱实例状态。参数值说明： Starting：开始启动 Ready：启动完成 Failed：启动失败 Terminating：终止中
RevisionNumber	Integer	1	函数实例版本编号。
AvailabilityZone	String	cn-beijing-b	沙箱实例所在可用区 ID。
InstanceType	String	elastic	沙箱实例类型。参数值说明： elastic：弹性实例 frozen：冻结实例 activated：激活实例 reserved：预留实例
ErrorCode	String	function_health_check_failed	沙箱实例启动失败错误码。参数值说明： internal_load_request_error：系统内部错误 function_initialize_failed：业务进程初始化错误 function_health_check_failed：健康检查错误 route_terminating：路由删除中正常启动沙箱实例时，该字段为空。
ErrorMessage	String	function_health_check_failed	沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
Pending	Boolean	true	沙箱实例是否处于 Pending 状态。参数值说明： true：是 false：否
RequestTimeout	Integer	60	沙箱实例请求最大超时时间。
MaxConcurrency	Integer	100	单个沙箱实例最大并发。
MemoryMB	Integer	1024	沙箱实例内存规格，单位为 MiB。
CpuMilli	Integer	500	沙箱实例 CPU 规格，单位为 milli cpu。
ImageInfo	Object of InstanceImageInfo	-	沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
Envs	Array of EnvVar	-	沙箱实例环境变量信息。
InstanceTosMountConfig	Object of InstanceTosMountConfig	-	沙箱实例 TOS 挂载信息，即实例级别的 TOS Bucket 挂载目录信息。

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	沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。

EnvVar

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

InstanceTosMountConfig

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

TosMountPoint

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

返回示例

错误码

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

函数服务