You need to enable JavaScript to run this app.
文档中心
AI 原生 BaaS 平台 Supabase 版

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
SDK 参考
概述
复制全文
下载 pdf
概述
为提高使用便利性和扩展性,满足更多业务场景需求,AI 原生 BaaS 平台 Supabase 版提供了 Go 语言和 Python 语言的 SDK。在本地安装 SDK 后,即可基于 AI 原生 BaaS 平台 Supabase 版提供的 Open API 进行开发。​
SDK 列表​
AI 原生 BaaS 平台 Supabase 版各版本 SDK 的相应的下载链接如下表所示。​
​
语言​
版本​
发布日期​
下载地址​
使用指导​
Python​
5.0.48​
2026-09-03​
​
5.0.42​
2026-07-23​
​
​
5.0.35​
2026-06-20​
​
​
5.0.32​
2026-06-03​
​
​
5.0.26​
2026-05-07​
​
​
5.0.16​
2026-04-28​
​
Go​
v1.2.51​
2026-09-03​
​
v1.2.44​
2026-07-23​
​
​
v1.2.36​
2026-06-20​
​
​
v1.2.33​
2026-06-03​
​
​
v1.2.27​
2026-05-07​
​
​
v1.2.19​
2026-03-12​
​
​
API 列表​
SDK 包含的 Open API 如下表所示。​
​
分类​
API​
说明​
所属的 SDK​
全局管理​
调用 ListWorkspaceUsageTop 接口对租户账号下所有 Workspace(工作区)的资源使用情况进行降序查询。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
​
Workspace 管理​
​
调用 CreateWorkspace 接口创建 Workspace(工作区)。​
​
​
调用 DescribeWorkspaces 接口查询 Workspace(工作区)列表。​
​
​
调用 DescribeWorkspaceDetail 接口查询 Workspace(工作区)详情。​
​
​
调用 DescribeWorkspaceDetailList 接口查询批量 Workspace(工作区)的详细信息。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 DescribeWorkspaceOverview 接口查询 Workspace(工作区)的概览信息。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
​
调用 ModifyComputeSettings 接口修改 Workspace(工作区)的初始算力配置。​
​
​
调用 ModifyWorkspaceSettings 接口修改 Workspace(工作区)的基础配置。​
​
​
调用 ModifyWorkspaceName 接口修改 Workspace(工作区)的名称。​
​
​
调用 DeleteWorkspace 接口删除 Workspace(工作区)。​
​
​
调用 ModifyWorkspaceDeletionProtectionPolicy 接口为 Workspace(工作区) 开启或关闭删除保护功能。​
​
​
调用 AddTagsToWorkspaces 接口为 Workspace(工作区) 绑定标签。​
​
​
调用 RemoveTagsFromWorkspaces 接口为 Workspace(工作区) 解绑标签。​
​
​
调用 StartWorkspace 接口启动已暂停的实例。​
​
​
调用 SuspendWorkspace 接口休眠运行中的实例。​
2026-09-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 StopWorkspace 接口暂停运行中的实例。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 DescribeChargeInfo 接口查询 Workspace 的计费信息。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 CreateWorkspacesExportTask 接口创建 Workspace 列表导出任务,将 Workspace 数据导出到 jsonl.gz 文件。可通过 DescribeWorkspacesExportTask 接口查询导出进度和下载链接。​
2026-09-03 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 DescribeWorkspacesExportTask 接口查询 Workspace 列表导出任务的执行状态、进度及下载链接,支持查询指定任务或当前账号最近一次导出任务。​
​
分支管理​
调用 CreateBranch 接口为 Workspace(工作区)创建分支。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 DescribeBranches 接口查询 Workspace(工作区)的分支列表。​
​
​
调用 DescribeBranchesList 接口查询批量 Workspace(工作区)的分支列表。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 DescribeChildBranches 接口查询分支的子分支列表。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 DescribeBranchDetail 接口查询分支的详细信息。​
​
​
调用 DescribeDefaultBranch 接口查询 Workspace(工作区)的默认分支。​
​
​
​
调用 DescribeDefaultBranchList 接口查询批量 Workspace(工作区)的默认分支。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 UpdateBranch 接口修改分支的配置。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 SetAsDefaultBranch 接口将分支设置为默认分支。​
​
​
调用 ResetBranch 接口重置分支。​
​
​
调用 GetRestoreWindow 接口查询分支的可恢复时间段。​
​
​
调用 DescribeRestorableBranches 接口查询 Workspace(工作区)在指定时间点的可恢复分支。​
​
​
调用 BranchRestore 接口恢复分支数据到指定时间点。​
​
​
调用 DescribeAPIKeys 接口查询 Workspace(工作区)的 API 密钥。​
​
​
调用 RestartBranch 接口重启分支。​
​
​
调用 DeleteBranch 接口删除分支。​
​
​
调用 EnableBranchAIFunction 接口开启分支的 AI Function 能力。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 ModifyBranchAIFunctionSettings 接口修改分支的 AI Function 配置。​
​
​
调用 DescribeBranchAIFunction 接口查询分支的 AI Function 功能的配置详情。​
​
​
调用 DescribeBranchSchemaNames 接口查询分支的 Schema 列表。​
​
​
调用 CreateSchemaDiff 接口创建分支对比任务。​
​
​
调用 DescribeSchemaDiffJobStatus 查询分支对比任务的状态。​
​
​
调用 DescribeSchemaDiffResultMeta 查询分支对比任务的详细信息。​
​
算力管理​
调用 DescribeSchemaDiffResultSQLText 查询分支对比结果的 SQL 文本。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
​
调用 DescribeSchemaDiffResultSQLTextAll 接口查询分支对比任务的完整迁移 SQL 文本。​
​
​
调用 GetSchemaDiffResultDownloadLink 获取分支对比结果的下载链接。​
​
​
调用 CreateCompute 接口创建算力。​
​
​
调用 DescribeComputes 接口查询分支的算力列表。​
​
​
调用 DescribeComputeDetail 接口查询算力详情。​
2026-09-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 ModifyComputeSpec 接口修改算力规格。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 ModifyComputeName 接口修改算力的名称。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 ModifyComputeParameters 修改参数的运行值。​
2026-07-23 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 DeleteDataLakeSecretConnection 接口删除数据湖连接。​
​
​
调用 DescribeDataLakeSecretConnection 接口查询数据湖连接。​
​
​
调用 CheckDataLakeSecretConnection 验证数据湖连接的连通性。​
​
​
调用 ListDatabasesDataLakeSecretConnection 接口查询创建了数据湖连接的库。​
​
账号管理​
调用 CreateDBAccount 接口为分支创建数据库账号。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
​
调用 DescribeDBAccounts 接口查询分支的数据库账号列表。​
​
​
调用 DescribeDBAccountConnection 接口查询数据库账号的连接信息。​
​
​
调用 ResetDBAccountPassword 接口重置数据库账号密码。​
​
​
调用 DeleteDBAccount 接口删除数据库账号。​
​
数据库管理​
调用 CreateDatabase 接口为分支创建数据库。​
​
​
调用 DescribeDatabases 接口查询分支的数据库。​
​
​
调用 DropDatabase 接口删除数据库。​
​
连接管理​
调用 DescribeWorkspaceEndpoint 接口查询 Workspace(工作区)的连接终端信息。​
​
​
调用 DescribeWorkspaceEndpointList 接口查询批量 Workspace(工作区)的终端信息。​
2026-06-03 及之后发布的 Python SDK 和 Go SDK​
​
调用 ModifyVpcSettings 接口修改 Workspace(工作区)使用的网络协议类型、私有网络和子网。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
​
调用 ModifyWorkspacePublicConnectionPolicy 接口开启或关闭 Workspace(工作区)的共享公网。​
​
​
调用 CreateEndpointPublicAddress 接口为 Workspace(工作区)的指定终端开启公网访问。​
​
​
调用 DeleteEndpointPublicAddress 接口为 Workspace(工作区)的指定终端关闭公网访问。​
​
​
调用 ModifyPrivateNetworkToSharedMode 接口设置 Workspace(工作区)的共享模式。​
​
​
调用 ResetWorkspaceAccountPassword 接口重置登录 Supabase 控制台的账号和密码。​
​
​
调用 ApplyPrivateDNSToPublic 接口开启或关闭 Workspace(工作区)的公网解析私网域名功能。​
2026-04-28 及之后发布的 Python SDK,和 2026-03-12 及之后发布的 Go SDK​
访问控制​
调用 CreateAccessControlList 接口为 Workspace(工作区)创建 IP 白名单。​
​
​
调用 DescribeAccessControlList 接口查询 Workspace(工作区)绑定的 IP 白名单。​
​
​
调用 ModifyAccessControlList 接口修改 Workspace(工作区)绑定的 IP 白名单。​
​
​
调用 DeleteAccessControlList 接口为 Workspace(工作区)移除 IP 白名单。​
​
任务管理​
调用 DescribeOperations 接口查询操作记录。​
​
前端部署​
调用 ListPagesProject 接口查询租户账号下的 Pages 项目列表,支持按名称筛选、分页查询和按 Supabase 绑定关系过滤。​
2026-06-20 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 BindPagesProject 接口将指定的 Pages 项目绑定到 Workspace/Branch,实现 Pages 应用与数据库的集成。​
​
​
调用 DescribePagesBinding 接口查询指定 Workspace/Branch 的 Pages 绑定详情,包括绑定的项目信息和环境变量配置。​
​
​
调用 SyncPagesDeployEnvVars 接口将 Supabase 的环境变量同步到绑定的 Pages 项目,确保 Pages 应用能获取最新的数据库连接信息。​
​
​
调用 UnbindPagesProject 接口解除 Pages 项目与 Supabase Workspace/Branch 的绑定关系,停止环境变量同步。​
​
​
调用 DescribeSupabaseDeployEnvVars 接口查询可同步到 Pages 的 Supabase 环境变量。​
​
大模型访问管理​
调用 DescribeBaasAIModels 接口查询访问大模型功能支持的模型列表。​
2026-07-23 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 DescribeBaasAIGlobalQuota 接口查询访问大模型功能的全局限额。​
​
​
调用 ModifyBaasAIGlobalQuota 接口修改访问大模型功能用户的全局模型限额。​
​
​
调用 DescribeBaasAIUserSummaries 接口查询访问大模型功能的模型使用汇总情况。​
​
​
调用 ModifyBaasAIUserQuotas 接口修改访问大模型功能用户的模型配额。​
​
SQL 限流​
调用 CreateSQLConcurrencyControlRule 接口创建 SQL 限流规则。​
2026-09-03 及之后发布的 Python SDK 和 Go SDK​
​
​
调用 ModifySQLConcurrencyControlRule 接口修改 SQL 限流规则。​
​
​
调用 DescribeSQLConcurrencyControlRules 接口查询 SQL 限流规则。​
​
​
调用 SwitchSQLConcurrencyControlRule 接口启用或禁用 SQL 限流规则。​
​
​
调用 DeleteSQLConcurrencyControlRule 接口删除 SQL 限流规则。​
​
​
​
最近更新时间:2026.09.09 11:46:15
这个页面对您有帮助吗?
有用
有用
无用
无用