文档中心

AI 原生 BaaS 平台 Supabase 版

分支管理

CreateBranch

CreateBranch

调用 CreateBranch 接口为 Workspace（工作区）创建分支。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	ideal-fir-9fc8****	Workspace 的 ID。
BranchSettings	Object of BranchSettings	是	请参见请求示例。	分支的基础配置。

BranchSettings

参数	类型	是否必选	示例值	描述
Name	String	是	test-branch	分支名称。分支名称应满足以下规则：长度需要在 1~128 个字符之间。只能包含字母（a~z 和 A~Z）、数字（0~9）、中划线（-）和下划线（_）。只能以字母（a~z 和 A~Z）开头，以字母（a~z 和 A~Z）或数字（0~9）结尾。
InitSource	String	是	ParentData	分支初始化的源。 ParentData：Schema 和数据。默认值。 SchemaOnly：仅 Schema 结构。说明该参数仅对使用 PostgreSQL 引擎和 veDB MySQL 引擎的 Workspace（工作区）有效。
ParentId	String	否	br-magic-foal-9771****	父分支 ID。说明不指定时则使用 Workspace 的默认分支作为父分支进行创建。
ParentTime	String	否	2025-10-08T09:11:12Z	分支从父分支创建时选择的数据同步时间点（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。
Protected	Boolean	否	false	是否为分支设置分支保护。取值： true：是。 false：否。默认值。
SkipDBRolesAndCredentialsRollback	Boolean	否	true	是否跳过数据库角色（DB Roles）和账号密码（Credentials）。取值： true：是。 false：否。默认值。

返回参数

参数	类型	示例值	描述
BranchId	String	br-magic-foal-9771****	分支 ID。
Branch	Object of Branch	请参见返回示例。	分支的详细信息。说明该字段仅在使用 PostgreSQL 的引擎中返回。
WorkspaceId	String	ideal-fir-9fc8****	Workspace 的 ID。

Branch

参数	类型	示例值	描述
Archived	Boolean	false	分支是否已归档。取值： true：是。 false：否。
BranchId	String	br-bloom-duck-61c7****	分支 ID。
BranchName	String	childbranch	分支的名称。
BranchStatus	String	Ready	分支的状态。取值： Unknown：未知。 Init：初始化。 Activating：激活中。 Ready：就绪。 Archived：已归档。 Deleted：已删除。 Resetting：重置中。 Deleting：删除中。 Stopping：暂停中。 Stopped：已暂停。 Suspending：休眠中。 Suspended：已休眠。 Replacing：计算资源替换中。 Restarting：重启中。 Updating：更新中。
BranchUsage	Object of BranchUsage	请参见返回示例。	分支的资源使用信息。
CreateTime	String	2025-10-08T10:51:06.000Z	分支的创建时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
CreationSource	String	Console	分支的创建源。取值为 Console。
Default	Boolean	false	是否为默认分支。取值： true：是。 false：否。
InitSource	String	ParentData	分支初始化的源，默认为 ParentData。 ParentData：Schema 和数据。 SchemaOnly：仅 Schema 结构。
LastResetTime	String	2025-10-07T08:57:21.000Z	分支最近一次重置的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明如分支没有进行过重置，则返回空。
ParentBranch	Object of ParentBranch	请参见返回示例。	该分支的父分支信息。说明如该分支无父分支时，则不返回该字段。当 Branch数据结构用于说明 ParentBranch 时，仅返回 BranchId、BranchName、BranchStatus 和 WorkspaceId 四个字段。
Protected	Boolean	true	是否为分支设置了分支保护。取值： true：是。 false：否。
StartParentLSN	String	0/3522648	该分支在创建时对应的父分支 LSN。
StartParentTime	String	2025-10-08T08:57:21.000Z	该分支从父分支创建时选择的数据同步时间点（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明如该分支没有父分支，则返回 1970-01-01T00:00:00.000Z。
StatusChangedTime	String	2025-10-08T10:16:45.000Z	分支状态变更时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
SupportAnalytic	Boolean	true	分支下的算力是否支持 AP 加速功能。取值： true：是。 false：否。
UpdateTime	String	2025-10-09T08:46:27.000Z	分支最近一次更新的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
WorkspaceId	String	ideal-fir-9fc8****	Workspace 的 ID。

BranchUsage

参数	类型	示例值	描述
BranchId	String	br-bloom-duck-61c7****	分支 ID。
ComputeTimeSeconds	Long	0	分支所有算力的算力用量，单位为秒。
DataSizeTotalBytes	Long	-1	分支数据占用的存储空间大小。单位为字节。说明返回值为 -1时表示无限制。
DataSizeUsedBytes	Long	24576	分支已使用数据大小，单位为字节。
FunctionCallNum	Long	3562	分支已调用函数次数。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
LastRunningTime	String	2025-10-21 06:46:33 +0000 UTC	分支的最后运行时间（UTC 时间）。格式为 yyyy-MM-dd HH:mm:ss +0000 UTC。
ServiceTimeSeconds	Long	365	分支已使用服务时长。
StatTime	String	2025-10-21 06:46:33 +0000 UTC	分支资源使用信息的统计时间（UTC 时间）。格式为 yyyy-MM-dd HH:mm:ss +0000 UTC。
StorageSizeUsedBytes	Long	24576	分支已使用存储服务数据大小，单位为字节。
WorkspaceId	String	ideal-fir-9fc8****	Workspace 的 ID。
VectorReadVCU	Double	19.22	对 Vector Bucket 中的向量数据发起检索、查询等读取操作时所消耗的查询资源。单位为 vCU。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
VectorWriteVCU	Double	7.3	向 Vector Bucket 中写入、更新或删除向量数据时所消耗的更新资源。单位为 vCU。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。
VectorStorageSizeUsedBytes	Long	909805	存储在 Vector Bucket 中的向量数据所占用的存储空间。单位为字节。说明该字段仅在使用 Supabase 引擎的 Workspace 中返回。

ParentBranch

参数	类型	示例值	描述
BranchId	String	br-bloom-duck-61c7****	分支 ID。
BranchName	String	main	分支的名称。
WorkspaceId	String	ideal-fir-9fc8****	Workspace 的 ID。
BranchStatus	String	Ready	分支的状态。取值： Unknown：未知。 Init：初始化。 Activating：激活中。 Ready：就绪。 Archived：已归档。 Deleted：已删除。 Resetting：重置中。 Deleting：删除中。 Stopping：暂停中。 Stopped：已暂停。 Suspending：休眠中。 Suspended：已休眠。 Replacing：计算资源替换中。 Restarting：重启中。 Updating：更新中。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.08.25 12:34:58

这个页面对您有帮助吗？

有用

有用

无用

无用