查询沙箱应用的实例列表。 ## 请求说明 * 请求方式：POST * 请求地址：http://open.volcengineapi.com/?Action=ListSandboxes&Version=2024\-06\-06 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |ListSandboxes |接口名称。当前 API 的名称为 `ListSandboxes`。 | |Version |String |是 |2024\-06\-06 |接口版本。当前 API 的版本为 `2024-06-06`。 | |FunctionId |String |是 |e8m6\*\*\*\* |沙箱应用 ID。|\ | | | | |在 [函数服务控制台](https://console.volcengine.com/vefaas) 的 **云沙箱** \> **沙箱应用** 页面获取沙箱应用 ID。 | |SandboxId |String |否 |vefaas\-e8m6xarn\-p2zamuv2fr\-\*\*\*\*\* |指定沙箱实例 ID/名称筛选。|\ | | | | |在 [函数服务控制台](https://console.volcengine.com/vefaas) 的 **云沙箱** \> **沙箱应用** 页面，具体沙箱应用的 **沙箱实例** 页签下获取沙箱实例 ID/名称。|\ | | | | |:::tip|\ | | | | |同时指定多个查询条件时，优先匹配沙箱实例 ID /名称来返回单个实例，或者返回实例不存在。|\ | | | | ||\ | | | | |:::| |Metadata |JSON Map |否 |{"app":"test"} |指定沙箱实例 Label 元信息筛选。 | |PageNumber |Integer |否 |1 |分页查询时的起始页码，从 1 开始，默认为 1。 | |PageSize |Integer |否 |10 |分页查询时每页显示的记录数，取值：|\ | | | | ||\ | | | | |* 最小值：1|\ | | | | |* 默认值：10 | |ImageUrl |String |否 |cr\-basic\-vefaas\-cn\-beijing.cr.volces.com/\*\*\*\*:latest |指定镜像地址查询沙箱实例列表。 | |Status |String |否 |Ready |指定沙箱实例状态查询沙箱实例列表，取值：|\ | | | | ||\ | | | | |* **Pending**：等待调度|\ | | | | |* **Starting**：开始启动|\ | | | | |* **Ready**：启动完成|\ | | | | |* **Failed**：启动失败|\ | | | | |* **Terminating**：终止中 | ## 请求示例 ```JSON POST http://open.volcengineapi.com/?Action=ListSandboxes&Version=2024-06-06 HTTP/1.1 Content-Type: application/json { "FunctionId": "e8m6****", "SandboxId": "vefaas-e8m6xarn-p2zamuv2fr-*****", "Metadata": { "app": "test" }, "PageNumber": 1, "PageSize": 10, "ImageUrl": "cr-basic-vefaas-cn-beijing.cr.volces.com/****:latest", "Status": "Ready" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Sandboxes |Array of [SandboxInfo](#sandboxinfo) |\- |沙箱实例列表。 | |Total |Integer |100 |沙箱实例总数。 | |StatusCount |JSON Map |{"Ready":100} |不同状态的沙箱实例数量分类。 | ### SandboxInfo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |vefaas\-e8m6xarn\-p2zamuv2fr\-\*\*\*\* |沙箱实例 ID/名称。 | |Image |String |enterprise\-cn\-beijing.cr.volces.com/vefaas\-public/sandbox\-fusion:20250509.python |沙箱实例镜像地址。 | |Status |String |Ready |沙箱实例状态。参数值说明：|\ | | | ||\ | | | |* **Starting**：开始启动|\ | | | |* **Ready**：启动完成|\ | | | |* **Failed**：启动失败|\ | | | |* **Terminating**：终止中 | |Pending |Boolean |true |沙箱实例是否处于 **Pending** 状态。参数值说明：|\ | | | ||\ | | | |* **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"} |沙箱实例 Label 元信息。 | |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`：路由删除中|\ | | | ||\ | | | |正常启动沙箱实例时，该字段为空。 | |FunctionId |String |e8m6\*\*\*\* |沙箱应用 ID。 | |ErrorMessage |String |function_health_check_failed |沙箱实例启动失败的错误码详情。|\ | | | |正常启动沙箱实例时，该字段为空。 | |InstanceType |String |elastic |沙箱实例类型。参数值说明：|\ | | | ||\ | | | |* **elastic**：弹性实例|\ | | | |* **frozen**：冻结实例|\ | | | |* **activated**：激活实例|\ | | | |* **reserved**：预留实例 | |RevisionNumber |Integer |1 |沙箱实例版本编号。 | |AvailabilityZone |String |cn\-beijing\-b |沙箱实例所在可用区 ID。 | ## 返回示例 ```JSON HTTP/1.1 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListSandboxes", "Version": "2024-06-06", "Service": "vefaas", "Region": "cn-beijing" }, "Result": { "Sandboxes": [ { "Id": "vefaas-e8m6xarn-p2zamuv2fr-****", "Image": "enterprise-cn-beijing.cr.volces.com/vefaas-public/sandbox-fusion:20250509.python", "Status": "Ready", "Pending": true, "CpuMilli": 500, "ExpireAt": "2025-04-25 11:31:29.376 +0000 UTC", "MemoryMB": 1024, "Metadata": { "app": "test" }, "CreatedAt": "2025-04-25 11:11:29.376 +0000 UTC", "ErrorCode": "function_health_check_failed", "FunctionId": "e8m6****", "ErrorMessage": "function_health_check_failed", "InstanceType": "elastic", "RevisionNumber": 1, "AvailabilityZone": "cn-beijing-b" } ], "Total": 100, "StatusCount": { "Ready": 100 } } } ``` ## 错误码当前接口暂无独立错误码，若接口调用返回异常，可参考 [公共错误码](https://www.volcengine.com/docs/6662/1261480)进行故障排查。