文档中心

函数服务

沙箱实例

ListSandboxes

ListSandboxes

查询沙箱应用的实例列表。

请求说明

请求方式：POST

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListSandboxes	接口名称。当前 API 的名称为 ListSandboxes。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
FunctionId	String	是	e8m6****	通过沙箱应用的 ID筛选沙箱实例。在沙箱应用页面获取沙箱应用 ID。登录沙箱应用的方法参见沙箱应用。
SandboxId	String	否	vefaas-e8m6xarn-p2zamuv2fr-*****	通过沙箱实例 ID 或名称筛选沙箱实例。在沙箱应用页面的沙箱实例页签下获取沙箱实例 ID 或名称。登录沙箱应用的方法参见沙箱应用。说明同时指定多个查询条件时，优先匹配沙箱实例 ID 和名称来返回单个实例，或者返回实例不存在。
Metadata	JSON Map	否	{"app":"test"}	通过沙箱实例元数据筛选沙箱实例。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值范围 1~100，默认值为 10。
ImageUrl	String	否	cr-basic-vefaas-cn-beijing.cr.volces.com/****:latest	通过镜像地址查询沙箱实例列表。
Status	String	否	Ready	通过沙箱实例状态查询沙箱实例列表，取值： Pending：等待调度。 Starting：开始启动。 Ready：启动完成。 Failed：启动失败。 Terminating：终止中。
Filters	Array of Filter	否	-	过滤条件，用于筛选沙箱实例。

Filter

参数	类型	是否必选	示例值	描述
Name	String	否	status	查询的筛选键（Key）。取值： revision：沙箱实例的版本。 status：沙箱实例的状态。取值： Pending：等待调度。 Starting：开始启动。 Ready：启动完成。 Failed：启动失败。 Terminating：终止中。 session_id：沙箱实例的会话 ID。
Values	Array of String	否	["Ready","Starting"]	查询的筛选值（Value）。多个值之间用半角逗号（,）分割。

请求示例

返回参数

参数	类型	示例值	描述
Sandboxes	Array of SandboxInfo	-	沙箱实例列表。
Total	Integer	100	沙箱实例总数。
StatusCount	JSON Map	{"Ready":100}	不同状态的沙箱实例的数量。
RevisionCount	JSON Map	{"1":50,"2":30}	不同版本编号对应的沙箱实例数量的映射，键为版本编号，值为该版本的沙箱实例数量。

SandboxInfo

参数	类型	示例值	描述
Id	String	vefaas-e8m6xarn-p2zamuv2fr-****	沙箱实例的 ID 或名称。
Image	String	-cn-beijing.cr.volces.com/vefaas-/sandbox-fusion:**.python	沙箱实例的镜像地址。
Status	String	Ready	沙箱实例状态。取值： Starting：开始启动。 Ready：启动完成。 Failed：启动失败。 Terminating：终止中。
Pending	Boolean	true	沙箱实例是否处于 Pending 等待调度状态，当 Status 尚未更新时，通过该字段判断是否在排队中。取值： true：处于等待调度状态。 false：默认值，不处于等待调度状态。
CpuMilli	Integer	500	沙箱实例的 CPU 规格，单位为 milli cpu。
ExpireAt	String	2025-04-25 11:31:29.376 +0000 UTC	沙箱实例的过期时间。
MemoryMB	Integer	1024	沙箱实例内存的规格，单位为 MiB。
Metadata	JSON Map	{"app":"test"}	沙箱实例的元数据。
CreatedAt	String	2025-04-25 11:11:29.376 +0000 UTC	沙箱实例创建的时间。
ErrorCode	String	function_health_check_failed	沙箱实例启动失败的错误码。取值： internal_load_request_error：系统内部错误。 function_initialize_failed：业务进程初始化错误。 function_health_check_failed：健康检查错误。 route_terminating：路由删除中。正常启动沙箱实例时，该字段为空。
SessionId	String	sess-12345****	沙箱实例的会话 ID。
FunctionId	String	e8m6****	沙箱应用 ID。
AssignStatus	String	ready	沙箱的分配状态，仅适用于开启沙箱预热池的场景。取值： ready：已预热可分配。 assigned：已分配。
ErrorMessage	String	function_health_check_failed	沙箱实例启动失败的报错信息。正常启动沙箱实例时，该字段为空。
InstanceType	String	elastic	沙箱实例类型。取值： elastic：弹性实例。 frozen：冻结实例。 activated：激活实例。 reserved：预留实例。
RevisionNumber	Integer	1	沙箱实例版本的编号。
AvailabilityZone	String	cn-beijing-b	沙箱实例所在可用区 ID。

返回示例

错误码

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

最近更新时间：2026.06.02 15:07:01

这个页面对您有帮助吗？

有用

有用

无用

无用