文档中心

AI 原生 BaaS 平台 Supabase 版

Workspace 管理

DescribeWorkspaceOverview

调用 DescribeWorkspaceOverview 接口查询 Workspace（工作区）的概览信息。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
ProjectName	String	否	default	所属项目的名称。
EngineType	String	否	PostgreSQL	引擎类型。取值： PostgreSQL：PostgreSQL 引擎。 veDB_MySQL：veDB MySQL 引擎。 Supabase：Supabase 引擎。

返回参数

参数	类型	示例值	描述
WorkspaceOverviews	Array of WorkspaceOverview	请参见返回示例。	Workspace 的概览信息。

WorkspaceOverview

参数	类型	示例值	描述
ClosedTotal	Integer	0	指定数据库引擎类型下处于“关停”状态的 Workspace 总数。
CreatingTotal	Integer	2	指定数据库引擎类型下处于“创建中”状态的 Workspace 总数。
EngineType	String	PostgreSQL	引擎类型。取值： PostgreSQL：PostgreSQL 引擎。 veDB_MySQL：veDB MySQL 引擎。 Supabase：Supabase 引擎。
ErrorTotal	Integer	0	指定数据库引擎类型下处于“创建失败”和“异常”状态 Workspace 总数。
RunningTotal	Integer	11	指定数据库引擎类型下处于“运行中”状态的 Workspace 总数。
StoppedTotal	Integer	1	指定数据库引擎类型下处于“已暂停”状态的 Workspace 总数。
SuspendedTotal	Integer	1	指定数据库引擎类型下处于“已休眠”状态的 Workspace 总数。
UpdatingTotal	Integer	0	指定数据库引擎类型下处于“变更中”和“网络变更中”状态的 Workspace 总数。
WorkspaceTotal	Integer	13	指定数据库引擎类型下的 Workspace 总数。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.06.24 10:58:43

这个页面对您有帮助吗？

有用

无用