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

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
API 参考
API 发布历史
复制全文
下载 pdf
API 发布历史
2026 年 10 月​
​
API​
发布时间​
变更记录​
关联功能​
删除DescribeWorkspacesUsageStatsInRange​
2026-10-22​
下线接口。​
实例管理​
2026-10-19​
新增接口。​
实例管理​
修改 公共结构体 - Workspace​
​
  • 新增参数 DelayedDeleteExpiredAt 和 DelayedDeleteStartedAt。​
  • 参数 WorkspaceStatus 新增取值 DelayedDelete。​
​
  • 新增请求参数 ProjectName。​
  • 请求参数 WorkspaceId 由必选变更为可选。​
分支管理​
修改 DeleteWorkspace​
​
新增请求参数 DelayedDelete。​
实例管理​
​
2026 年 09 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-09-02​
新增接口。​
实例管理​
​
2026 年 08 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-08-24​
新增接口。​
SQL 限流​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
算力管理​
​
新增请求参数 EffectType。​
​
修改 公共结构体 - WorkspaceUsage​
​
新增参数 VectorReadVCU、VectorStorageSizeUsedBytes 和 VectorStorageSizeUsedBytes。​
​
  • 新增请求参数 NextToken。​
  • 新增返回参数 NextToken 和 HasMore。​
Workspace 管理​
修改 StartWorkspace​
​
新增请求参数 StartAsSuspended。​
​
修改 公共结构体 - BranchSettings​
​
新增参数 SkipDBRolesAndCredentialsRollback。​
修改 公共结构体 - BranchUsage​
​
新增参数 VectorReadVCU、VectorStorageSizeUsedBytes 和 VectorStorageSizeUsedBytes。​
修改 公共结构体 - RestoreSettings​
​
新增参数 SkipDBRolesAndCredentialsRollback。​
修改 公共结构体 - BaasAIModelQuota​
​
新增参数 DailyImageLimit。​
修改 公共结构体 - BaasAIModelUsage​
​
新增参数 TotalImages 和 LastDailyImages。​
​
2026 年 07 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-07-31​
新增接口。​
Workspace 管理​
​
​
​
2026-07-16​
​
大模型访问管理​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
算力管理​
​
​
​
​
​
​
​
​
​
​
​
​
修改 CreateCompute​
​
更新接口注意事项,补充只读算力和 DuckDB 只读算力的数量限制。​
​
修改 公共结构体 - ComputeSettings​
​
  • 更新参数 ComputeRole 的取值范围,增加 Analytic 的取值。​
  • 更新参数 ComputeRole 的描述信息,增加“如主算力的 AP 加速功能已开启,则不能再创建 DuckDB 只读算力”的限制信息。​
​
2026 年 06 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-06-20​
新增接口。​
前端部署​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
2026-06-20​
请求参数 AccountName 由必选改为可选。​
账号管理​
修改 CreateBranch​
​
移除请求参数 ComputeSettings。​
分支管理​
修改 CreateWorkspace​
​
新增请求参数 AgentPlanSettings。​
Workspace 管理​
修改 公共结构体 - Workspace​
​
新增参数 IsAgentPlan 和 AgentPlanSeatId,用于说明 Workspace 的 Agent Plan 相关的配置信息。​
新增 公共结构体 - AgentPlanSettings​
​
新增结构体。​
修改 公共结构体 - Workspace​
2026-06-01​
移除参数 StorageSize 和 StorageSize。​
​
2026 年 05 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-05-28​
新增接口。​
分支管理​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
2026-05-20​
​
Workspace 管理​
​
​
连接管理​
​
​
算力管理​
​
​
分支管理​
​
​
​
​
​
Workspace 管理​
修改 公共结构体 - DefaultComputeSettings​
​
  • 参数 EnableAnalytics 更名为 EnableAnalytic。​
  • 更新参数的描述信息,增加“仅对使用 PostgreSQL 引擎的 Workspace 生效”的限制信息。​
修改 公共结构体 - ComputeSettings​
​
​
修改 公共结构体 - Compute​
​
​
修改 公共结构体 - Branch​
​
新增参数 SupportAnalytic。​
修改 公共结构体 - DefaultWorkspaceSettings​
​
更新参数 HistoryRetentionHours 的描述信息,移除对 Supabase 引擎类型的限制。​
​
2026 年 04 月​
​
API​
发布时间​
变更记录​
关联功能​
修改 公共结构体 - DefaultNetworkSettings​
2026-04-20​
新增参数 SharedPublicNetwork。​
修改 公共结构体 - DefaultComputeSettings​
​
新增 EnableAnalytics 参数。​
修改 公共结构体 - ComputeSettings​
​
​
修改 DescribeAPIKeys​
​
  • 新增请求参数 Offset 和 Limit。​
  • 新增返回参数 Total。​
分支管理​
修改 公共结构体 - Compute​
​
新增 EnableAnalytics 参数。​
​
更新请求参数 SuspendTimeoutSeconds 的取值范围。​
Workspace 管理​
修改 CreateCompute​
​
更新接口的注意事项,新增对 veDB 引擎的支持。​
算力管理​
修改 DeleteCompute​
​
​
​
修改 CreateDBAccount​
​
更新请求参数 AccountPassword 的描述信息,补充密码的设置规则。​
账号管理​
​
​
​
修改 公共结构体 - Endpoint​
​
更新参数 EndpointType 的取值范围,增加 Dashboard 的取值。​
修改 公共结构体 - Branch​
​
更新参数 BranchStatus 的取值范围,新增取值 Updating。​
修改 公共结构体 - ParentBranch​
​
​
​
修改 DescribeWorkspacesUsageStatsInRange​
2026-04-17​
新增请求参数 EngineType。​
Workspace 管理​
​
2026 年 03 月​
​
API​
发布时间​
变更记录​
关联功能​
2026-03-16​
新增接口。​
任务管理​
​
​
连接管理​
修改 公共结构体 - Workspace​
​
新增参数 BaasComputeSettings 和 DNSVisibility。​
修改 公共结构体 - Compute​
​
新增参数 ServiceType。​
修改 公共结构体 - BranchSettings​
​
修改参数 InitSource 的描述信息,说明该参数仅对使用 PostgreSQL 引擎和 veDB MySQL 引擎的 Workspace(工作区)有效。​
​
  • 新增请求参数 ServiceType。​
  • 更新请求参数 AutoScalingLimitMaxCU 和 AutoScalingLimitMinCU 的描述信息,说明因算力类型不同时两个参数的不同取值范围。​
Workspace 管理​
​
新增请求参数 ServiceType。​
算力管理​
​
更新请求参数 AutoScalingLimitMaxCU 和 AutoScalingLimitMinCU 的描述信息,说明因算力类型不同时两个参数的不同取值范围。​
​
修改 BranchRestore​
2026-03-04​
更新接口的注意事项,补充该接口已新增对使用 Supabase 引擎的 Workspace 的支持。​
分支管理​
​
​
​
修改 CreateDatabase​
​
新增请求参数 DatabaseDesc。​
数据库管理​
修改 公共结构体 - Database​
​
新增参数 DatabaseDesc。​
修改 CreateDBAccount​
​
新增请求参数 AccountDesc。​
账号管理​
修改 公共结构体 - Account​
​
新增参数 AccountDesc。​
修改 公共结构体 - APIKey​
​
  • 为参数 Name 明确取值范围。​
  • 参数 Type 新增取值 Service。​
修改 公共结构体 - Workspace​
​
新增参数 WorkspaceTags。​
​
2026 年 02 月​
​
API​
发布时间​
变更记录​
关联功能​
新增 StartWorkspace​
2026-02-26​
新增接口。​
Workspace 管理​
新增 StopWorkspace​
​
​
​
​
​
分支管理​
​
​
连接管理​
修改 CreateCompute​
​
更新请求参数 ComputeName 的描述信息(命名规则更新)​
算力管理​
​
新增请求参数 Filters。​
Workspace 管理​
修改 DeleteBranch​
​
移除接口的注意事项。​
分支管理​
​
更新返回参数 StartTime 和 EndTime 的描述信息。​
​
​
更新接口的注意事项。​
算力管理​
​
更新接口的注意事项,补充如何查询 Workspace 私网网络当前的共享模式的方法。​
连接管理​
​
  • 更新接口的注意事项,补充该接口已新增对使用 Supabase 引擎的 Workspace 的支持。​
  • 新增仅用于使用 Supabase 引擎的 Workspace 的请求参数 BranchId。​
​
修改 RestartBranch​
​
更新接口的注意事项,补充该接口已新增对使用 Supabase 引擎的 Workspace 的支持。​
分支管理​
​
​
​
修改 公共结构体 - DefaultWorkspaceSettings​
​
新增参数 PublicConnection。​
修改 公共结构体 - Workspace​
​
更新参数 WorkspaceStatus 的取值范围(新增 Workspace 状态)。​
修改 公共结构体 - BranchObject​
​
更新参数 BranchStatus 的取值范围(新增分支状态)。​
修改 公共结构体 - Compute​
​
更新参数 ComputeStatus 的取值范围(新增算力状态)。​
修改 公共结构体 - BranchUsage​
​
新增参数 FunctionCallNum、ServiceTimeSeconds 和 StorageSizeUsedBytes。三个字段都仅在使用 Supabase 引擎的 Workspace 中返回。​
修改 公共结构体 - QueryFilter​
​
更新参数 Value 的取值范围(新增算力状态)。​
修改 CreateCompute​
​
请求参数 BranchId 由可选变更为必选。​
算力管理​
修改 UpdateBranch​
​
更新请求参数 Name 的描述信息,更新命名规则。​
分支管理​
​
请求参数 EndpointId 和 EipId 由必选变更为可选,并更新参数说明。​
连接管理​
​
请求参数 EndpointId 由必选变更为可选。​
​
修改 公共结构体 - WorkspaceOverviewObject​
​
新增参数 ClosedTotal、StoppedTotal 和 StoppedTotal。​
​
2026 年 01 月​
​
API​
发布时间​
变更记录​
关联功能​
修改 CreateBranch​
2026-01-29​
移除请求参数 ComputeSettings。​
分支管理​
2026-01-15​
新增接口。​
Workspace 管理​
​
​
​
新增 RestartBranch​
​
​
分支管理​
​
​
算力管理​
​
​
连接管理​
​
​
访问控制​
​
​
​
​
​
​
​
​
​
修改 CreateWorkspace​
​
新增请求参数 WorkspaceTags。​
Workspace 管理​
​
​
​
新增 公共结构体 - TagOption​
​
新增数据结构。​
修改 公共结构体 - WorkspaceUsage​
​
新增参数 FunctionCallNum。​
修改 公共结构体 - Workspace​
​
新增参数 SharedPrivateNetwork。​
修改 公共结构体 - RestoreSettings​
​
新增参数 SourceBranchId。​
2026-01-09​
  • 为请求参数 ComputeId 和 BranchId 增加可选性的说明。​
  • 为返回参数 BranchId 增加返回时机的说明。​
连接管理​
​
2025 年 12 月​
​
API​
发布时间​
变更记录​
关联功能​
修改 公共结构体 - DefaultWorkspaceSettings​
2025-12-02​
移除参数 DeletionProtection。​
​
  • 新增 ServiceTimeSeconds 参数,表示已使用服务时长,仅在使用 Supabase 引擎的 Workspace 中返回。​
  • 新增 StorageSizeUsedBytes 参数,表示已使用存储服务数据大小,仅在使用 Supabase 引擎的 Workspace 中返回。​
全局管理​
修改 CreateWorkspace​
​
新增内容​
  • EngineVersion 参数新增取值 Supabase_1_24,支持创建 Supabase 1.24 引擎版本的 Workspace。​
  • EngineType 参数新增取值 Supabase,支持 Supabase 引擎类型。​
  • DefaultWorkspaceSettings 新增参数 DeletionProtection,用于控制 Workspace 的删除保护功能状态,取值包括 Enabled(默认)和 Disabled。​
  • DefaultNetworkSettings 新增参数 SharedPrivateNetwork,用于控制是否共享私网 IP,取值包括 true(共享)和 false(默认不共享)。​
  • Workspace 返回参数新增 DeletionProtectionStatus,表示 Workspace 的删除保护功能状态。​
  • WorkspaceUsage 返回参数新增:。​
  • ServiceTimeSeconds:已使用服务时长(仅 Supabase 引擎返回)。​
  • StorageSizeUsedBytes:已使用存储服务数据大小(仅 Supabase 引擎返回)。​
修改内容​
  • NetworkSettings 参数的必选条件扩展为:当 EngineVersion 取值为 veDB_MySQL_8_0 或 Supabase_1_24 时必选。​
  • ComputeSettings 参数的描述从"Workspace 的计算配置"修改为"Workspace 的初始计算配置"。​
  • HistoryRetentionHours 参数新增提示:作为请求参数时仅适用于 PostgreSQL 和 veDB MySQL 引擎的 Workspace。​
  • Workspace 返回参数的 EngineType 和 EngineVersion 新增 Supabase 相关取值。​
注意事项​
  • 使用新增的 Supabase 引擎类型时需注意:​
  • 必须配置 NetworkSettings 参数。​
  • 返回的用量统计包含专有字段 ServiceTimeSeconds 和 StorageSizeUsedBytes。​
  • 删除保护功能默认开启,如需删除 Workspace 需先关闭该功能。​
Workspace 管理​
​
  • 新增 DeletionProtectionStatus 参数,用于表示 Workspace 的删除保护功能状态,取值包括 AllowDeletion(关闭)和 DeletionProtectionEnable(开启)。​
  • 在 EngineType 参数中新增 Supabase 引擎类型。​
  • 在 EngineVersion 参数中新增 Supabase_1_24 引擎版本。​
  • 新增 DeletionProtection 参数,用于表示 Workspace 的删除保护功能状态,取值包括 Enabled(开启)和 Disabled(关闭)。​
  • 在 WorkspaceUsage 中新增 ServiceTimeSeconds 和 StorageSizeUsedBytes 参数,分别表示已使用服务时长和已使用存储服务数据大小,仅在使用 Supabase 引擎的 Workspace 中返回。​
  • 在 DefaultWorkspaceSettings 的 HistoryRetentionHours 参数描述中新增提示,说明该参数仅能用于操作使用 PostgreSQL 引擎和 veDB MySQL 引擎的 Workspace。​
​
​
  • 新增 DeletionProtectionStatus 参数,用于表示 Workspace 的删除保护功能状态,取值包括 AllowDeletion(可删除)和 DeletionProtectionEnable(不可删除)。​
  • 在 EngineType 参数中新增 Supabase 引擎类型。​
  • 在 EngineVersion 参数中新增 Supabase_1_24 引擎版本。​
  • 在 DefaultWorkspaceSettings 中新增 DeletionProtection 参数,用于表示 Workspace 的删除保护功能状态,取值包括 Enabled(已开启)和 Disabled(已关闭)。​
  • 在 WorkspaceUsage 中新增 ServiceTimeSeconds 参数,表示已使用服务时长,仅在使用 Supabase 引擎的 Workspace 中返回。​
  • 在 WorkspaceUsage 中新增 StorageSizeUsedBytes 参数,表示已使用存储服务数据大小,仅在使用 Supabase 引擎的 Workspace 中返回。​
​
​
  • EngineType 参数新增取值 Supabase,支持查询 Supabase 引擎类型的 Workspace 概览信息。​
  • ErrorTotal 参数描述由“指定数据库引擎类型下异常状态 Workspace 总数”修改为“指定数据库引擎类型下处于‘创建失败’和‘异常’状态 Workspace 总数”,明确包含的状态类型。​
  • UpdatingTotal 参数描述由“指定数据库引擎类型下处于‘变更中’状态的 Workspace 总数”修改为“指定数据库引擎类型下处于‘变更中’和‘网络变更中’状态的 Workspace 总数”,扩展了包含的状态类型。​
​
​
  • 在 Workspace 对象中新增了 DeletionProtectionStatus 参数,用于表示 Workspace 的删除保护功能状态。​
  • 在 EngineType 参数中新增了 Supabase 引擎类型选项。​
  • 在 EngineVersion 参数中新增了 Supabase_1_24 引擎版本选项。​
  • 在 DefaultWorkspaceSettings 对象中新增了 DeletionProtection 参数,用于设置 Workspace 的删除保护功能状态。​
  • 在 DefaultWorkspaceSettings 对象的 HistoryRetentionHours 参数描述中新增了提示信息,说明该参数仅适用于 PostgreSQL 和 veDB MySQL 引擎的 Workspace。​
  • 在 WorkspaceUsage 对象中新增了 ServiceTimeSeconds 和 StorageSizeUsedBytes 参数,用于记录使用 Supabase 引擎的 Workspace 的服务时长和存储服务数据使用量。​
​
​
  • 新增 DeletionProtection 参数,用于控制 Workspace 的删除保护功能状态,可选值为 Enabled(默认)和 Disabled。​
  • 在 DefaultWorkspaceSettings 中,为 HistoryRetentionHours 参数新增提示信息,说明该参数仅适用于 PostgreSQL 和 veDB MySQL 引擎的 Workspace。​
  • 在 Workspace 返回参数中新增 DeletionProtectionStatus 字段,用于返回 Workspace 的删除保护功能状态,取值包括 AllowDeletion 和 DeletionProtectionEnable。​
  • 在 EngineType 中新增 Supabase 引擎类型。​
  • 在 EngineVersion 中新增 Supabase_1_24 引擎版本。​
  • 在 WorkspaceUsage 中新增 ServiceTimeSeconds 和 StorageSizeUsedBytes 字段,用于记录使用 Supabase 引擎的 Workspace 的服务时长和存储服务数据大小,并添加相关提示信息。​
​
​
  • 新增 DeletionProtectionStatus 参数,用于表示 Workspace 的删除保护功能状态,取值包括 AllowDeletion 和 DeletionProtectionEnable。​
  • 在 EngineType 参数中新增 Supabase 引擎类型。​
  • 在 EngineVersion 参数中新增 Supabase_1_24 引擎版本。​
  • 在 DefaultWorkspaceSettings 中新增 DeletionProtection 参数,用于设置 Workspace 的删除保护功能状态,取值包括 Enabled 和 Disabled。​
  • 在 WorkspaceUsage 中新增 ServiceTimeSeconds 参数,表示已使用服务时长,仅在使用 Supabase 引擎的 Workspace 中返回。​
  • 在 WorkspaceUsage 中新增 StorageSizeUsedBytes 参数,表示已使用存储服务数据大小,仅在使用 Supabase 引擎的 Workspace 中返回。​
​
​
新增 ModifyWorkspaceDeletionProtectionPolicy 接口,用于为 Workspace(工作区)开启或关闭删除保护功能。​
​
修改 UpdateBranch​
​
  • Name 参数的描述中新增了限制说明:该参数仅能用于操作使用 PostgreSQL 引擎和 veDB MySQL 引擎的 Workspace(工作区)。​
  • Protected 参数的描述中新增了限制说明:该参数仅能用于操作使用 PostgreSQL 引擎的 Workspace(工作区)。​
分支管理​
新增 DescribeAPIKeys​
​
新增 DescribeAPIKeys 接口,用于查询 Workspace(工作区)的 API 密钥。​
​
​
  • 在请求参数中新增了 BranchId 参数,该参数为可选参数,表示分支 ID。​
  • 修改了 WorkspaceId 参数的描述,从 "Workspace ID" 调整为 "Workspace 的 ID"。​
  • 返回参数中调整了字段顺序,将 ComputeId 移至首位,WorkspaceId 移至末尾。​
  • 在 Address 结构中新增了 AddressPort 参数,表示终端关联的 IPv4/IPv6 地址端口。​
连接管理​
​
  • 接口描述中新增了对网络协议类型修改的说明,明确表示 ModifyVpcSettings 接口现在支持修改网络协议类型。​
  • 其他参数和描述保持不变,没有新增、修改或删除的参数。​
​
​
新增 CreateEndpointPublicAddress 接口,用于为 Workspace(工作区)的指定终端开启公网访问。​
​
​
新增 DeleteEndpointPublicAddress 接口,用于为 Workspace(工作区)的指定终端关闭公网访问。​
​
​
2025 年 10 月​
​
API​
发布时间​
变更记录​
关联功能​
2025-10-31​
- Endpoint 新增参数 Addresses(结构体),移除参数 AddressDomain 和 AddressType(均移入 Addresses)。​
连接管理​
​
- 移除请求参数 EndpointId,新增请求参数 AddressId。​
账号管理​
​
- BranchId 参数由可选(否)变更为必选(是)。在创建算力时,必须提供分支 ID。​
算力管理​
修改 CreateCompute​
​
​
​
修改 CreateDatabase​
2025-10-29​
- 为参数 DatabaseOwner 补充可选性描述。​
数据库管理​
修改 CreateWorkspace​
​
- 更新参数 InternetProtocol 的取值范围。​
Workspace 管理​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
连接管理​
修改 CreateWorkspace​
2025-10-27​
- DefaultComputeSettings 中的 AutoScalingLimitMaxCU 和 AutoScalingLimitMinCU 参数描述更新,明确了取值范围和默认值。​
Workspace 管理​
​
  • AutoScalingLimitMaxCU 参数描述更新,新增取值范围和默认值说明,默认值从 32 调整为 2,并明确单位为 CU。​
  • AutoScalingLimitMinCU 参数描述更新,新增取值范围和默认值说明,默认值保持 0.25,并明确单位为 CU。​
​
修改 CreateCompute​
​
  • ComputeSettings.AutoScalingLimitMaxCU 描述新增了取值范围说明:"取值为 [0.25, 0.5, 1~32] 范围内的整数值,默认值为 2,单位为 CU"。​
  • ComputeSettings.AutoScalingLimitMinCU 描述新增了取值范围说明:"取值为 [0.25, 0.5, 1~32] 范围内的整数值,默认值为 0.25,单位为 CU"。​
算力管理​
​
  • AutoScalingLimitMinCU 参数描述新增取值范围说明:[0.25, 0.5,1~32] 范围内的整数值,默认值为 0.25,单位为 CU。​
  • AutoScalingLimitMaxCU 参数描述新增取值范围说明:[0.25, 0.5,1~32] 范围内的整数值,默认值为 2,单位为 CU。​
​
​
​
​
最近更新时间:2026.10.22 20:20:35
这个页面对您有帮助吗?
有用
有用
无用
无用