文档中心

AI 原生 BaaS 平台 Supabase 版

沙箱服务

DescribeBaasSandboxUserSummaries

调用 DescribeBaasSandboxUserSummaries 接口查询用户的沙箱配额和用量。

请求类型

同步请求。

注意事项

该接口仅能用于操作使用 Supabase 引擎的 Workspace（工作区）。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	noble-heath-3a48****	Workspace 的 ID。
BranchId	String	是	br-merry-scup-42d3****	Branch ID。
Offset	Integer	否	0	分页查询起始，可取大于等于 0 的整数值，默认值为 0。
Limit	Integer	否	20	分页查询时单页的返回数量，取值范围为 1～100，默认值为 10，传 0 按默认值处理。
Search	String	否	alice	用户搜索关键词，支持用户 ID、用户名、邮箱或手机号模糊匹配。

返回参数

参数	类型	示例值	描述
Total	Long	1	满足搜索条件的用户总数。
UserSummaryItems	Array of BaasSandboxUserSummaryItem	请参见返回示例。	用户配额与用量列表。

BaasSandboxUserSummaryItem

参数	类型	示例值	描述
CreateTime	String	2026-07-01T08:00:00Z	用户创建时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。系统账号可能为空。
CustomQuota	Object of BaasSandboxQuota	请参见返回示例。	自定义配额。仅 QuotaCustomized 取值为 true 时返回。
Email	String	alice@example.com	用户邮箱，可能为空。
QuotaCustomized	Boolean	true	是否设置自定义配额。取值： true ：是。 false ：否。表示恢复跟随全局默认值。
ReadOnly	Boolean	false	是否为只读系统账号。
Usage	Object of BaasSandboxUsage	请参见返回示例。	用户创建用量统计。
UserId	String	7b973f0e-****	用户 ID。
UserName	String	Alice	用户名。系统账号统一显示为 System Admin。

BaasSandboxQuota

参数	类型	示例值	描述
DailySandboxLimit	Long	100	默认每日创建限额，-1 表示不限额，0 表示禁止创建，正整数表示每日上限。

BaasSandboxUsage

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.10.29 12:20:37

这个页面对您有帮助吗？

有用

无用