文档中心

AI 原生 BaaS 平台 Supabase 版

API 参考

API 列表

说明

单个地域下，API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

API 调用的超时时间为 30 秒。

全局管理

API	说明
DescribeAccountUsage	调用 DescribeAccountUsage 接口查询租户账号下的资源使用信息。
ListWorkspaceUsageTop	调用 ListWorkspaceUsageTop 接口对租户账号下所有 Workspace（工作区）的资源使用情况进行降序查询。

Workspace 管理

API	说明
CreateWorkspace	调用 CreateWorkspace 接口创建 Workspace（工作区）。
DescribeWorkspaces	调用 DescribeWorkspaces 接口查询 Workspace（工作区）列表。
DescribeWorkspaceDetail	调用 DescribeWorkspaceDetail 接口查询 Workspace（工作区）的详细信息。
DescribeWorkspaceDetailList	调用 DescribeWorkspaceDetailList 接口查询批量 Workspace（工作区）的详细信息。
DescribeWorkspaceOverview	调用 DescribeWorkspaceOverview 接口查询 Workspace（工作区）的概览信息。
ModifyComputeSettings	调用 ModifyComputeSettings 接口修改 Workspace（工作区）的初始算力配置。
ModifyWorkspaceSettings	调用 ModifyWorkspaceSettings 接口修改 Workspace（工作区）的基础配置。
ModifyWorkspaceName	调用 ModifyWorkspaceName 接口修改 Workspace（工作区）的名称。
DeleteWorkspace	调用 DeleteWorkspace 接口删除 Workspace（工作区）。
ModifyWorkspaceDeletionProtectionPolicy	调用 ModifyWorkspaceDeletionProtectionPolicy 接口为 Workspace（工作区）开启或关闭删除保护功能。
AddTagsToWorkspaces	调用 AddTagsToWorkspaces 接口为 Workspace（工作区）绑定标签。
RemoveTagsFromWorkspaces	调用 RemoveTagsFromWorkspaces 接口为 Workspace（工作区）解绑标签。
StartWorkspace	调用 StartWorkspace 接口启动已暂停的实例。
SuspendWorkspace	调用 SuspendWorkspace 接口休眠运行中的实例。
StopWorkspace	调用 StopWorkspace 接口暂停运行中的实例。
DescribeChargeInfo	调用 DescribeChargeInfo 接口查询 Workspace 的计费信息。
CreateWorkspacesExportTask	调用 CreateWorkspacesExportTask 接口创建 Workspace 列表导出任务，将 Workspace 数据导出到 jsonl.gz 文件。可通过 DescribeWorkspacesExportTask 接口查询导出进度和下载链接。
DescribeWorkspacesExportTask	调用 DescribeWorkspacesExportTask 接口查询 Workspace 列表导出任务的执行状态、进度及下载链接，支持查询指定任务或当前账号最近一次导出任务。
RecoverDelayedDeleteWorkspace	调用 RecoverDelayedDeleteWorkspace 接口恢复处于延迟删除中状态的 Workspace（工作区）。

分支管理

API	说明
CreateBranch	调用 CreateBranch 接口为 Workspace（工作区）创建分支。
DescribeBranches	调用 DescribeBranches 接口查询 Workspace（工作区）的分支列表。
DescribeBranchesList	调用 DescribeBranchesList 接口查询批量 Workspace（工作区）的分支列表。
DescribeChildBranches	调用 DescribeChildBranches 接口查询分支的子分支列表。
DescribeBranchDetail	调用 DescribeBranchDetail 接口查询分支的详细信息。
DescribeDefaultBranch	调用 DescribeDefaultBranch 接口查询 Workspace（工作区）的默认分支。
DescribeDefaultBranchList	调用 DescribeDefaultBranchList 接口查询批量 Workspace（工作区）的默认分支。
UpdateBranch	调用 UpdateBranch 接口修改分支的配置。
SetAsDefaultBranch	调用 SetAsDefaultBranch 接口将分支设置为默认分支。
ResetBranch	调用 ResetBranch 接口重置分支。
GetRestoreWindow	调用 GetRestoreWindow 接口查询分支的可恢复时间段。
DescribeRestorableBranches	调用 DescribeRestorableBranches 接口查询 Workspace（工作区）在指定时间点的可恢复分支。
BranchRestore	调用 BranchRestore 接口恢复分支数据到指定时间点。
DescribeAPIKeys	调用 DescribeAPIKeys 接口查询 Workspace（工作区）的 API 密钥。
RestartBranch	调用 RestartBranch 接口重启分支。
DeleteBranch	调用 DeleteBranch 接口删除分支。
DescribeBranchSchemaNames	调用 DescribeBranchSchemaNames 接口查询分支的 Schema 列表。
CreateSchemaDiff	调用 CreateSchemaDiff 接口创建分支对比任务。
DescribeSchemaDiffJobStatus	调用 DescribeSchemaDiffJobStatus 查询分支对比任务的状态。
DescribeSchemaDiffResultMeta	调用 DescribeSchemaDiffResultMeta 查询分支对比任务的详细信息。
DescribeSchemaDiffResultSQLText	调用 DescribeSchemaDiffResultSQLText 查询分支对比结果的 SQL 文本。
DescribeSchemaDiffResultSQLTextAll	调用 DescribeSchemaDiffResultSQLTextAll 接口查询分支对比任务的完整迁移 SQL 文本。
GetSchemaDiffResultDownloadLink	调用 GetSchemaDiffResultDownloadLink 获取分支对比结果的下载链接。

算力管理

API	说明
CreateCompute	调用 CreateCompute 接口创建算力。
DescribeComputes	调用 DescribeComputes 接口查询分支的算力列表。
DescribeComputeDetail	调用 DescribeComputeDetail 接口查询算力详情。
ModifyComputeSpec	调用 ModifyComputeSpec 接口修改算力规格。
ModifyComputeName	调用 ModifyComputeName 接口修改算力的名称。
ModifyComputeParameters	调用 ModifyComputeParameters 修改参数的运行值。
DeleteCompute	调用 DeleteCompute 接口删除算力。
ModifyComputeAnalyticPolicy	调用 ModifyComputeAnalyticPolicy 接口开启主算力的 AP 加速功能。
CreateDataLakeSecretConnection	调用 CreateDataLakeSecretConnection 接口创建数据湖连接。
DeleteDataLakeSecretConnection	调用 DeleteDataLakeSecretConnection 接口删除数据湖连接。
DescribeDataLakeSecretConnection	调用 DescribeDataLakeSecretConnection 接口查询数据湖连接。
CheckDataLakeSecretConnection	调用 CheckDataLakeSecretConnection 验证数据湖连接的连通性。
ListDatabasesDataLakeSecretConnection	调用 ListDatabasesDataLakeSecretConnection 接口查询创建了数据湖连接的库。

账号管理

API	说明
CreateDBAccount	调用 CreateDBAccount 接口为分支创建数据库账号。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询分支的数据库账号列表。
DescribeDBAccountConnection	调用 DescribeDBAccountConnection 接口查询数据库账号的连接信息。
ResetDBAccountPassword	调用 ResetDBAccountPassword 接口重置数据库账号密码。
DeleteDBAccount	调用 DeleteDBAccount 接口删除数据库账号。

数据库管理

API	说明
CreateDatabase	调用 CreateDatabase 接口为分支创建数据库。
DescribeDatabases	调用 DescribeDatabases 接口查询分支的数据库。
DropDatabase	调用 DropDatabase 接口删除数据库。

连接管理

API	说明
DescribeWorkspaceEndpoint	调用 DescribeWorkspaceEndpoint 接口查询 Workspace（工作区）的连接终端信息。
DescribeWorkspaceEndpointList	调用 DescribeWorkspaceEndpointList 接口查询批量 Workspace（工作区）的终端信息。
ModifyVpcSettings	调用 ModifyVpcSettings 接口修改 Workspace（工作区）使用的网络协议类型、私有网络和子网。
ModifyWorkspacePublicConnectionPolicy	调用 ModifyWorkspacePublicConnectionPolicy 接口开启或关闭 Workspace（工作区）的共享公网。
CreateEndpointPublicAddress	调用 CreateEndpointPublicAddress 接口为 Workspace（工作区）的指定终端开启公网访问。
DeleteEndpointPublicAddress	调用 DeleteEndpointPublicAddress 接口为 Workspace（工作区）的指定终端关闭公网访问。
ModifyPrivateNetworkToSharedMode	调用 ModifyPrivateNetworkToSharedMode 接口设置 Workspace（工作区）的共享模式。
ResetWorkspaceAccountPassword	调用 ResetWorkspaceAccountPassword 接口重置登录 Supabase 控制台的账号和密码。
ApplyPrivateDNSToPublic	调用 ApplyPrivateDNSToPublic 接口开启或关闭 Workspace（工作区）的公网解析私网域名功能。

访问控制

API	说明
CreateAccessControlList	调用 CreateAccessControlList 接口为 Workspace（工作区）创建 IP 白名单。
DescribeAccessControlList	调用 DescribeAccessControlList 接口查询 Workspace（工作区）绑定的 IP 白名单。
ModifyAccessControlList	调用 ModifyAccessControlList 接口修改 Workspace（工作区）绑定的 IP 白名单。
DeleteAccessControlList	调用 DeleteAccessControlList 接口为 Workspace（工作区）移除 IP 白名单。

任务管理

API	说明
DescribeOperations	调用 DescribeOperations 接口查询操作记录。

前端部署

API	说明
ListPagesProject	调用 ListPagesProject 接口查询租户账号下的 Pages 项目列表，支持按名称筛选、分页查询和按 Supabase 绑定关系过滤。
BindPagesProject	调用 BindPagesProject 接口将指定的 Pages 项目绑定到 Workspace/Branch，实现 Pages 应用与数据库的集成。
DescribePagesBinding	调用 DescribePagesBinding 接口查询指定 Workspace/Branch 的 Pages 绑定详情，包括绑定的项目信息和环境变量配置。
SyncPagesDeployEnvVars	调用 SyncPagesDeployEnvVars 接口将 Supabase 的环境变量同步到绑定的 Pages 项目，确保 Pages 应用能获取最新的数据库连接信息。
UnbindPagesProject	调用 UnbindPagesProject 接口解除 Pages 项目与 Supabase Workspace/Branch 的绑定关系，停止环境变量同步。
DescribeSupabaseDeployEnvVars	调用 DescribeSupabaseDeployEnvVars 接口查询可同步到 Pages 的 Supabase 环境变量。

大模型访问管理

API	说明
DescribeBaasAIModels	调用 DescribeBaasAIModels 接口查询访问大模型功能支持的模型列表。
DescribeBaasAIGlobalQuota	调用 DescribeBaasAIGlobalQuota 接口查询访问大模型功能的全局限额。
ModifyBaasAIGlobalQuota	调用 ModifyBaasAIGlobalQuota 接口修改访问大模型功能用户的全局模型限额。
DescribeBaasAIUserSummaries	调用 DescribeBaasAIUserSummaries 接口查询访问大模型功能的模型使用汇总情况。
ModifyBaasAIUserQuotas	调用 ModifyBaasAIUserQuotas 接口修改访问大模型功能用户的模型配额。

SQL 限流

API	说明
CreateSQLConcurrencyControlRule	调用 CreateSQLConcurrencyControlRule 接口创建 SQL 限流规则。
ModifySQLConcurrencyControlRule	调用 ModifySQLConcurrencyControlRule 接口修改 SQL 限流规则。
DescribeSQLConcurrencyControlRules	调用 DescribeSQLConcurrencyControlRules 接口查询 SQL 限流规则。
SwitchSQLConcurrencyControlRule	调用 SwitchSQLConcurrencyControlRule 接口启用或禁用 SQL 限流规则。
DeleteSQLConcurrencyControlRule	调用 DeleteSQLConcurrencyControlRule 接口删除 SQL 限流规则。

最近更新时间：2026.10.22 20:18:40

这个页面对您有帮助吗？

有用

无用