AI 原生 BaaS 平台 Supabase 版
AI 原生 BaaS 平台 Supabase 版
AI 原生 BaaS 平台 Supabase 版
文档指南
请输入
用户指南
Supabase 引擎用户指南
Workspace 管理
任务管理
使用 Supabase 控制台
使用 Authentication
PostgreSQL 引擎用户指南
Workspace 管理
任务管理
插件
veDB MySQL 引擎用户指南（邀测）
Workspace 管理
任务管理
API 参考
Workspace 管理
分支管理
算力管理
账号管理
连接管理
前端部署
大模型访问管理
SQL 限流
最佳实践
相关协议
- 文档首页
AI 原生 BaaS 平台 Supabase 版API 参考数据库管理DescribeDatabases
复制全文
下载 pdfDescribeDatabases
文档反馈
问问助手调用 DescribeDatabases 接口查询分支的数据库。
请求类型
同步请求。
注意事项
该接口仅能用于操作使用 PostgreSQL 引擎和 veDB MySQL 引擎的 Workspace（工作区）。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
WorkspaceId | String | 是 | noble-heath-3a48**** | Workspace 的 ID。 |
BranchId | String | 是 | br-merry-scup-42d3**** | 分支 ID。 |
Offset | Integer | 否 | 1 | 分页查询起始，可取大于等于 0 的整数值，默认值为 0。 |
Limit | Integer | 否 | 5 | 分页查询数量，可取大于等于 1 的整数值，默认值为 10。 |
Search | String | 否 | 测试 | 搜索的关键字。支持按账号名称模糊搜索。 |
SortOrder | String | 否 | Asc | 排序方式。
|
返回参数
参数 | 类型 | 示例值 | 描述 |
Databases | 请参见返回示例。 | 符合查询条件的数据库列表。 | |
Total | Integer | 3 | 符合查询条件的数据库总数。 |
Database
参数 | 类型 | 示例值 | 描述 |
BranchId | String | br-merry-scup-42d3**** | 分支 ID。 |
CreateTime | String | 2025-10-21T08:06:52Z | 数据库的创建时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。 |
DatabaseDesc | String | This is a description of a database. | 数据库的描述信息。 |
DatabaseName | String | test-db | 数据库的名称。 |
DatabaseOwner | String | test-user | 数据库的所属的账号。 |
UpdateTime | String | 2025-10-21T08:06:52Z | 数据库的更新时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。 |
WorkspaceId | String | noble-heath-3a48**** | Workspace 的 ID。 |
示例
请求示例
POST /?Action=DescribeDatabases&Version=2025-10-01 HTTP/1.1
Content-Type: application/json
Host: aidap.cn-beijing.volcengineapi.com
X-Date: 20251001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20251001/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"WorkspaceId": "frank-melon-9dd3****",
"BranchId": "br-bloom-ibex-56e0****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeDatabases",
"Version": "2025-10-01",
"Service": "aidap",
"Region": "cn-beijing"
},
"Result": {
"Databases": [
{
"BranchId": "br-bloom-ibex-56e0****",
"CreateTime": "2025-10-21T08:06:52Z",
"DatabaseDesc": "This is a description of a database."
"DatabaseName": "test-db",
"DatabaseOwner": "test-user",
"UpdateTime": "2025-10-21T08:06:52Z",
"WorkspaceId": "frank-melon-9dd3****"
}
],
"Total": 1
}
}
错误码
最近更新时间：2026.06.24 10:58:46
这个页面对您有帮助吗？
有用
有用
无用
无用