You need to enable JavaScript to run this app.
文档中心
AI 原生 BaaS 平台 Supabase 版

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
沙箱服务
DescribeBaasSandboxes
复制全文
下载 pdf
DescribeBaasSandboxes
调用 DescribeBaasSandboxes 接口查询指定 Workspace 指定分支上运行的沙箱。​
请求类型​
同步请求。​
注意事项​
该接口仅能用于操作使用 Supabase 引擎的 Workspace(工作区)。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
WorkspaceId​
String​
是​
noble-heath-3a48****​
Workspace 的 ID。​
BranchId​
String​
是​
br-merry-scup-42d3****​
Branch ID。​
SandboxId​
String​
否​
35q6spfjixq54bxba4gadn****​
按 Sandbox ID 精确匹配。​
OwnerUserId​
String​
否​
System Admin​
按实际启动沙箱的用户 ID 精确匹配。​
Status​
String​
否​
​
RUNNING​
沙箱状态。取值:​
  • CREATING:创建中。​
  • STARTING:启动中。​
  • RUNNING:运行中。​
  • PAUSING:暂停中。​
  • PAUSED:已暂停。​
  • RESUMING:恢复中。​
  • STOPPING:停止中。​
  • STOPPED:已停止。​
  • KILLED:已回收。​
  • FAILED:失败。​
Offset​
Integer​
否​
0​
分页查询起始,可取大于等于 0 的整数值,默认值为 0。​
Limit​
Integer​
否​
​
20​
分页查询时单页的返回数量,取值范围为 1~100,默认值为 10,传 0 按默认值处理。​
TemplateName​
String​
否​
opencode​
按来源模板名称精确匹配。取值:​
  • opencode​
  • codex​
  • code-interpreter​
  • base​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Total​
Long​
​
1​
满足完整筛选条件的实例总数。​
Sandboxes​
Array of Sandbox​
请参见返回示例。​
沙箱列表。​
​
Sandbox​
​
参数​
类型​
示例值​
描述​
CpuMilli​
Integer​
2000​
CPU 规格,单位为 milli-core(毫核)。​
CreatedAt​
String​
2026-10-26T03:48:29Z​
创建时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
EndedAt​
String​
​
结束时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
FailReason​
String​
​
失败原因。沙箱状态不为 FAILED 或无失败原因时不返回。​
MemMb​
Integer​
4096​
内存规格,单位为 MB。​
OwnerUserId​
String​
System Admin​
实际启动该沙箱的用户 ID。​
RemainingTtlSeconds​
Long​
562​
剩余 TTL 秒数;已过期返回 0,未设置 TTL 时不返回。​
SandboxId​
String​
35q6spfjixq54bxba4gadn****​
Sandbox 的 ID。​
Status​
String​
RUNNING​
沙箱状态。取值:​
  • CREATING:创建中。​
  • STARTING:启动中。​
  • RUNNING:运行中。​
  • PAUSING:暂停中。​
  • PAUSED:已暂停。​
  • RESUMING:恢复中。​
  • STOPPING:停止中。​
  • STOPPED:已停止。​
  • KILLED:已回收。​
  • FAILED:失败。​
TemplateName​
String​
opencode​
来源模板的名称。​
TimeoutAt​
String​
2026-10-26T04:03:30Z​
预计超时时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。未设置 TTL 时不返回。​
UpdatedAt​
String​
2026-10-26T03:48:30Z​
最后更新时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
​
示例​
请求示例​
​
POST /?Action=DescribeBaasSandboxes&Version=2025-10-01​
Content-Type: application/json​
Host: aidap.cn-beijing.volcengineapi.com​
X-Date: 20251001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20251001/cn-beijing/aidap/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"WorkspaceId": "noble-heath-3a48****",​
"BranchId": "br-merry-scup-42d3****",​
"SandboxId": "35q6spfjixq54bxba4gadn****",​
"OwnerUserId": "System Admin",​
"Status": "RUNNING",​
"Offset": 0,​
"Limit": 20,​
"TemplateName": "opencode"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeBaasSandboxes",​
"Version": "2025-10-01",​
"Service": "aidap",​
"Region": "cn-beijing"​
},​
"Result": {​
"Sandboxes": [​
{​
"MemMb": 4096,​
"Status": "RUNNING",​
"EndedAt": "",​
"CpuMilli": 2000,​
"CreatedAt": "2026-10-26T03:48:29Z",​
"SandboxId": "35q6spfjixq54bxba4gadn****",​
"TimeoutAt": "2026-10-26T04:03:30Z",​
"UpdatedAt": "2026-10-26T03:48:30Z",​
"FailReason": "",​
"OwnerUserId": "System Admin",​
"TemplateName": "opencode",​
"RemainingTtlSeconds": 562​
}​
],​
"Total": 1​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.10.29 12:20:36
这个页面对您有帮助吗?
有用
有用
无用
无用