文档中心

AI 原生 BaaS 平台 Supabase 版

连接管理

DescribeWorkspaceEndpoint

调用 DescribeWorkspaceEndpoint 接口查询 Workspace（工作区）的连接终端信息。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	noble-heath-3a48****	Workspace 的 ID。
ComputeId	String	否	cp-brave-hills-ad69****	算力的 ID。说明如果 Workspace 使用的是 PostgreSQL 引擎或 veDB MySQL 引擎，该参数为必选。如果 Workspace 使用的是 Supabase 引擎，该参数为可选。
BranchId	String	否	br-bloom-duck-61c7****	分支 ID。说明如果 Workspace 使用的是 PostgreSQL 引擎或 veDB MySQL 引擎，该参数为可选。如果 Workspace 使用的是 Supabase 引擎，该参数为必选。

返回参数

参数	类型	示例值	描述
BranchId	String	br-bloom-duck-61c7****	分支 ID。说明该参数不会在所有的请求中都返回，取决于 Workspace 使用的引擎类型。如果 Workspace 使用的是 PostgreSQL 引擎或 veDB MySQL 引擎，不返回该参数。如果 Workspace 使用的是 Supabase 引擎，返回该参数。
ComputeId	String	cp-brave-hills-ad69****	算力的 ID。
Endpoints	Array of Endpoint	请参见返回示例。	Workspace 的连接终端信息。
WorkspaceId	String	noble-heath-3a48****	Workspace 的 ID。

Endpoint

参数	类型	示例值	描述
Addresses	Array of Address	请参见返回示例。	终端的连接信息。
EndpointId	String	ep-15d73b055d662534****	连接终端的 ID。
EndpointName	String	ep-15d73b055d662534****	连接终端的名称。
EndpointType	String	Proxy	终端类型。取值： Proxy：共享终端。 Dashboard：独享终端。

Address

参数	类型	示例值	描述
AddressDomain	String	cp-fiery-tide-1958****.pg.aidap-global.cn-beijing.volces.com	终端关联的域名。
AddressId	String	addr-ffac9dc170a3c6fa****	地址的 ID。
AddressPort	Integer	80	终端关联的 IPv4/IPv6 地址端口。
AddressType	String	Public	终端关联的地址类型。取值： Public：公网地址。 Private：私网地址。
IPAddress	String	192.*.*.4	终端关联的私网 IPv4 地址。说明终端关联的地址类型为公网地址时，该字段返回为空。
IPv6Address	String	2406:**:::::**:b38c	终端关联的私网 IPv6 地址。

示例

请求示例

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

无用