调用 DescribeWorkspaces 接口查询 Workspace（工作区）列表。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
ProjectName	String	否	default	指定按项目查询的项目。
Limit	Integer	否	5	分页查询数量，可取大于等于 1 的整数值，默认值为 10。
Offset	Integer	否	1	分页查询起始，可取大于等于 0 的整数值，默认值为 0。
Search	String	否	测试	搜索的关键字。支持按 Workspace ID 或 Workspace 名称进行模糊搜索。
SortBy	String	否	create_time	排序字段，取值： update_time：更新时间。默认值。 create_time：创建时间。 workspace_name：Workspace 名称。
SortOrder	String	否	Asc	排序方式。 Asc：升序排序。 Desc：降序排序。默认值。
Filters	Array of QueryFilter	否	请参见请求示例。	查询时的过滤条件。
WorkspaceTags	Array of TagOption	否	请参见请求示例。	通过标签查询数组对象。说明单次最多支持同时传入 10 组标签键值对进行查询筛选。如指定了多个标签进行查询，多个标签键之间为“与”关系，同一个标签键的不同标签值为“或”关系。
NextToken	String	否		游标分页查询时传入。说明向 NextToken 传入有效值即可采用游标分页查询。不传时继续按照分页查询。首次使用游标分页查询时，需传入 None。

QueryFilter

参数	类型	是否必选	示例值	描述
Name	String	是	WorkspaceStatus	查询时的筛选项。取值： WorkspaceStatus：按 Workspace 运行状态查询。 DBEngineVersion：按引擎类型查询。
Value	String	是	"CreateFailed,Error"	指定筛选项的筛选值。当参数 Name 取值为WorkspaceStatus 时，Value 的取值可为： Unknown：未知状态。 Creating：创建中。 CreateFailed：创建失败。 Updating：变更中。 Running：运行中。 Deleted：已删除。 Error：异常。 NetworkChanging：网络变更中。 Closing：计费关停中。 Closed：已关停。 Resuming：计费关停恢复中。 Stopping：实例暂停中。 Stopped：已暂停。 Starting：实例启动中。 Suspending：休眠中。 Suspended：已休眠。当参数 Name 取值为DBEngineVersion 时，Value 的取值可为： PostgreSQL_17： PostgreSQL 引擎。 Supabase_1_24：Supabase 引擎。说明支持传入多个值，多个值之间用（,）分隔。

TagOption

参数	类型	是否必选	示例值	描述
Key	String	是	Tag_key	Workspace 的标签的键。标签键的拟定规则如下：使用 UTF-8 编码的 Unicode。不能以任何大小写形式的 volc: 或 sys 开头。 volc: 和 sys为系统预留标签键，禁止使用。只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。长度限制在 1~128 个字符之间。说明标签的键对大小写敏感。单次创建的标签数量不能超过 20 个。单个 Workspace 下的标签键不能重复。单个 Workspace 下，一个标签键仅能有一个标签值。
Value	String	否	Tag_value	Workspace 的标签的值。标签值的拟定规则如下：使用 UTF-8 编码的 Unicode。只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。允许为空，长度限制在 0~256 个字符之间。说明标签值对大小写敏感。

返回参数

参数	类型	示例值	描述
HasMore	Boolean	true	游标分页时返回，表示是否还有下一页数据。取值： true：是。 false：否。
NextToken	String	eyJzb3J0X2J5IjoidXBkYXRlX3RpbWUiLCJzb3J0X2Rlc2MiOnRydWUsImxhc3Rfc29ydCI6MTc4NzIxOTY1NjAwMDAwMDAwMCwibGFzdF9pZCI6OTQ0Mj****==	使用游标分页查询时返回，用于查询下一页数据。
Total	Integer	29	符合查询条件的结果总数。
Workspaces	Array of Workspace	请参见返回示例。	符合查询条件的 Workspace 列表。

Workspace

参数	类型	示例值	描述
AccountId	String	210036****	Workspace 所属租户的 ID。
AgentPlanSeatId	String	seat-20260615134321-kjvvx	Agent Plan 的 Seat ID。说明该参数仅在使用的是 Agent Plan 的企业版时返回。
BaasComputeSettings	Object of DefaultComputeSettings	请参见返回示例。	Supabase 服务算力的配置信息。说明该字段仅在使用 Supabase 引擎的 Workspace（工作区）中返回。
ComputeSettings	Object of DefaultComputeSettings	请参见返回示例。	Workspace 的算力配置信息。
CreateTime	String	2025-10-20T06:47:49Z	Workspace 的创建时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。
CreationSource	String	Console	Workspace 的创建来源。取值： AIPA：通过 AIPA 创建。 CLI：通过 CLI 创建。 Console：通过控制台创建。 Coze：通过 Coze 创建。 MCP：通过 MCP 创建。 SDK：通过 SDK 创建。 Terraform：通过 Terraform 创建。 Trae：通过 Trae 创建。 Unknown：未知创建来源。
DeletionProtectionStatus	String	Enable	Workspace 的删除保护功能的状态。取值： AllowDeletion：删除保护功能已关闭，Workspace 可被直接删除。 DeletionProtectionEnable：删除保护功能已开启，Workspace 不可被直接删除。
DNSVisibility	Boolean	false	公网解析私网域名功能是否开启。取值： true：是。 false：否。
EngineType	String	PostgreSQL	引擎类型。取值： PostgreSQL：PostgreSQL 引擎。 veDB_MySQL：veDB MySQL 引擎。 Supabase：Supabase 引擎。
EngineVersion	String	PostgreSQL_17	引擎版本。取值： PostgreSQL_17： PostgreSQL 17。 veDB_MySQL_8_0：veDB MySQL 8.0。 Supabase_1_24：Supabase 1.24。
InternetProtocol	String	IPv4	Workspace 使用的 IP 地址协议版本。 DualStack：IPv4 + IPv6。 IPv4：IPv4。
IsAgentPlan	Boolean	true	是否为 Agent Plan 使用的 Workspace。取值： true：是。 false：否。默认值。
ProjectName	String	default	Workspace 所属的项目名称。
RegionId	String	cn-beijing	Workspace 所属地域的 ID。
SharedPrivateNetwork	Boolean	true	Workspace 的私有网络是否开启了共享模式。开启后，Workspace 将支持使用泛域名访问，并且不会为每个算力节点新增解析记录。取值： true：是。 false：否。说明未开启时不返回该字段。
StatusChangedTime	String	2025-10-20T06:48:15Z	Workspace 状态变更时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。
SubnetId	String	subnet-3rf442t6a54w016nf3pg9****	Workspace 使用的子网的 ID。
UpdateTime	String	2025-10-21T05:32:19Z	Workspace 的更新时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。
VpcId	String	vpc-3ezxu117lv18g72200rro****	Workspace 使用的私网的 ID。说明如 Workspace 未使用私网，则返回空。
WorkspaceId	String	ideal-fir-9fc8****	Workspace 的 ID。
WorkspaceName	String	测试Workspace	Workspace 的名称。
WorkspaceSetting	Object of DefaultWorkspaceSettings	请参见返回示例。	Workspace 的配置信息。
WorkspaceStatus	String	Running	Workspace 的运行状态。取值： Unknown：未知状态。 Creating：创建中。 CreateFailed：创建失败。 Updating：变更中。 Running：运行中。 Deleted：已删除。 Error：异常。 NetworkChanging：网络变更中。 Closing：计费关停中。 Closed：已关停。 Resuming：计费关停恢复中。 Stopping：实例暂停中。 Stopped：已暂停。 Starting：实例启动中。 Suspending：休眠中。 Suspended：已休眠。
WorkspaceUsage	Object of WorkspaceUsage	请参见返回示例。	Workspace 使用详情：已使用的存储空间、已使用的算力等
WorkspaceTags	Array of Tag	请参见返回示例。	Workspace 的标签。说明如 Workspace 未绑定标签，则返回 null。

DefaultComputeSettings

参数	类型	示例值	描述
AutoScalingLimitMaxCU	Double	4	Workspace 算力自动扩展范围的上限。取值为 [0.25\|0.5\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10\|11\|12\|13\|14\|15\|16\|18\|20\|22\|24\|26\|28\|30\|32]，默认值为 2，单位为 CU。说明 AutoScalingLimitMaxCU 与 AutoScalingLimitMinCU 的取值范围相同，但 AutoScalingLimitMaxCU 的取值应大于 AutoScalingLimitMinCU 的取值。 AutoScalingLimitMaxCU 与 AutoScalingLimitMinCU 的比值不能大于 8。
AutoScalingLimitMinCU	Double	0.25	Workspace 算力自动扩展范围的下限。取值为 [0.25\|0.5\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10\|11\|12\|13\|14\|15\|16\|18\|20\|22\|24\|26\|28\|30\|32]，默认值为 0.25，单位为 CU。说明 AutoScalingLimitMaxCU 与 AutoScalingLimitMinCU 的取值范围相同，但 AutoScalingLimitMaxCU 的取值应大于 AutoScalingLimitMinCU 的取值。 AutoScalingLimitMaxCU 与 AutoScalingLimitMinCU 的比值不能大于 8。
SuspendTimeoutSeconds	Integer	300	算力挂起时间，算力无活动操作达到设定时间后，自动挂起节点。取值为 -1 时表示永不挂起。
EnableAnalytic	String	Enabled	Workspace 的 AP 加速功能的状态。取值： Enabled：开启。 Disabled：关闭。说明该字段仅对使用 PostgreSQL 引擎的 Workspace 生效。作为请求参数时，默认值为 Disabled。

DefaultWorkspaceSettings

参数	类型	示例值	描述
DeletionProtection	String	Enabled	Workspace 的删除保护功能的状态。取值： Enabled：已开启。默认值。 Disabled：已关闭。
HistoryRetentionHours	Integer	48	Workspace 的可回溯时间。取值范围为 1~720，默认值为 48，单位为小时。
PublicConnection	String	Enabled	Workspace 的共享公网功能的状态。取值： Enabled：已开启。 Disabled：已关闭。

WorkspaceUsage

参数	类型	示例值	描述
BranchComputeTimeSeconds	Long	4240159	Workspace 的分支使用的算力时长。单位为秒。
BranchCreatedNum	Long	12	Workspace 的分支数量。单位为个。
ComputeTimeSeconds	Long	4560259	Workspace 使用的算力时长。单位为秒。
DataSizeTotalBytes	Long	-1	存储空间大小。单位为字节。说明返回值为 -1时表示无限制。
DataSizeUsedBytes	Long	90980352	Workspace 已使用的数据空间大小。单位为字节。
FunctionCallNum	Long	45443	已调用函数次数。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
ServiceTimeSeconds	Long	12	已使用服务时长。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
StatTime	String	2025-10-20T03:46:01Z	数据的统计时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。
StorageSizeUsedBytes	Long	6944	已使用存储服务数据大小。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
VectorReadVCU	Double	19.22	对 Vector Bucket 中的向量数据发起检索、查询等读取操作时所消耗的查询资源。单位为 vCU。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
VectorStorageSizeUsedBytes	Long	909805	存储在 Vector Bucket 中的向量数据所占用的存储空间。单位为字节。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
VectorWriteVCU	Double	7.3	向 Vector Bucket 中写入、更新或删除向量数据时所消耗的更新资源。单位为 vCU。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。

Tag

参数	类型	示例值	描述
Key	String	key1	标签的键。
Value	String	value1	标签的值。
System	Boolean	false	是否为系统标签。取值： true：是。 false：否。

示例

请求示例

返回示例

错误码

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

AI 原生 BaaS 平台 Supabase 版