文档中心

函数服务

沙箱镜像

ListSandboxImages

ListSandboxImages

批量获取预热镜像信息。

请求说明

请求方式：POST

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListSandboxImages	接口名称。当前 API 的名称为 ListSandboxImages。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
ImageType	String	是	private	镜像类型：取值： private：自定义镜像 public：公共镜像
Filters	Array of SandboxImageFilter	否	-	待查询预热镜像信息的筛选条件。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 默认值：10

SandboxImageFilter

参数	类型	是否必选	示例值	描述
Key	String	否	id	过滤条件 Key，取值： id：沙箱镜像 ID。 source_image_url：沙箱镜像地址。 precache_status：沙箱镜像预热状态。 image_group：沙箱镜像类别。
Values	Array of String	否	["9px3******"]	过滤条件 Value。沙箱镜像 ID、镜像地址、预热状态、镜像类别等信息，可调用 GetSandboxImagePrecacheTicket 接口获取。

请求示例

返回参数

参数	类型	示例值	描述
Images	Array of SandboxImage	-	镜像列表。
TotalCount	Integer	100	镜像总数。

SandboxImage

参数	类型	示例值	描述
ImageId	String	9px3r68nu9	沙箱镜像 ID。
ImageUrl	String	vefaas-**.cr.volces.com/vefaas-cr/**:latest	沙箱镜像地址。
ImageGroup	String	Code	沙箱镜像类别，参数值说明： Code：Code 运行环境镜像。 Browser：Browser 运行环境镜像。 All-in-one：高度集成、多功能的云端开发与执行环境镜像。 SWE：【邀测·申请试用】SWE-bench 系列镜像。
UpdateTime	String	2025-04-25 11:11:29.376 +0000 UTC	沙箱镜像最近更新时间。
PrecacheStatus	String	success	沙箱镜像预热状态，参数值说明： success：已预热 failed：预热失败 caching：预热中
PrecacheStatusReason	String	-	沙箱镜像预热失败的原因。
RelatedSandboxApplications	Array of String	["wxd2****"]	沙箱镜像关联的沙箱应用 ID 列表。

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

有用

无用

无用