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 参考算力管理DescribeDataLakeSecretConnection
复制全文
下载 pdfDescribeDataLakeSecretConnection
文档反馈
问问助手调用 DescribeDataLakeSecretConnection 接口查询数据湖连接。
请求类型
同步请求。
注意事项
该接口仅能用于操作使用 PostgreSQL 引擎的 Workspace（工作区）。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
WorkspaceId | String | 是 | ideal-fir-9fc8**** | Workspace 的 ID。 |
BranchId | String | 是 | br-merry-scup-42d3**** | 分支 ID。 |
DatabaseName | String | 是 | testDB | 数据库名称。 |
SecretName | String | 否 | testConnection | 数据湖连接的名称。 说明 如不指定，则查询指定数据库下的所有数据湖连接。 |
Limit | Integer | 否 | 5 | 分页查询数量，可取大于等于 1 的整数值，默认值为 10。 |
Offset | Integer | 否 | 1 | 分页查询起始，可取大于等于 0 的整数值，默认值为 0。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
Secrets | 请参见返回示例。 | 符合查询条件的数据湖连接的详细信息。 | |
Total | Long | 3 | 符合查询条件的结果总数。 |
DataLakeSecret
参数 | 类型 | 示例值 | 描述 |
AccessKeyID | String | AKLTMDcyNTA4YzIwYWUxNDkzNDhmYzRkNDU1NmUwZGU**** | 租户身份的 Access Key 的 ID。 |
DatabaseName | String | testDB | 数据库名称。 |
Endpoint | String | tos-cn-beijing.volces.com | 对象存储 TOS 的接入地址。 |
Name | String | testConnection | 数据湖连接的名称。 |
Scope | String | | |
Type | String | TOS | 数据湖连接的类型。当前仅支持 TOS 类型。 |
Username | String | testUser | 用户名。 |
示例
请求示例
POST /?Action=DescribeDataLakeSecretConnection&Version=2025-10-01
Content-Type: application/json
Host: aidap.cn-beijing.volcengineapi.com
X-Date: 20251001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20251001/cn-beijing/aidap/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"WorkspaceId": "ideal-fir-9fc8****",
"BranchId": "br-merry-scup-42d3****",
"SecretName": "testConnection",
"Limit": 5,
"Offset": 1,
"DatabaseName": "testDB"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202607072123529FCB9DAB7883835B208E-84c51a",
"Action": "DescribeDataLakeSecretConnection",
"Version": "2025-10-01",
"Service": "aidap",
"Region": "cn-guilin-boe"
},
"Result": {
"Secrets": [
{
"AccessKeyID": "",
"DatabaseName": "testDB",
"Endpoint": "tos-cn-beijing.volces.com",
"Name": "testconnection",
"Scope": "",
"Type": "TOS",
"Username": "user_admin"
},
{
"AccessKeyID": "",
"DatabaseName": "testDB",
"Endpoint": "tos-cn-beijing.volces.com",
"Name": "testconnection2",
"Scope": "",
"Type": "TOS",
"Username": "user_admin"
},
{
"AccessKeyID": "",
"DatabaseName": "testDB",
"Endpoint": "tos-cn-beijing.volces.com",
"Name": "testconnection3",
"Scope": "",
"Type": "TOS",
"Username": "user1"
}
],
"Total": 3
}
}
错误码
最近更新时间：2026.07.17 17:32:17
这个页面对您有帮助吗？
有用
有用
无用
无用