ListBranches - 查询分支列表
查询 Supabase 项目的分支列表。
接口说明
该接口用于分页查询指定 Supabase 项目下的所有分支，支持按父分支、关键字和排序条件筛选。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。 |
cn-beijing |
| PageSize |
integer |
否 |
每页记录数。 可选值：
默认值：20。 |
20 |
| PageNumber |
integer |
否 |
页码。取值需大于 0，默认值为 1。 |
1 |
| ParentBranchId |
string |
否 |
父分支 ID，用于指定新分支或查询条件的上级分支。 |
br-main |
| Search |
string |
否 |
搜索关键字。支持按分支 ID 或分支名称模糊搜索。 |
main |
| SortBy |
string |
否 |
排序字段。 可选值：
默认值：CreateTime。 |
CreateTime |
| SortOrder |
string |
否 |
排序方向。 可选值：
默认值：Desc。 |
Desc |
| NextToken |
string |
否 |
分页查询的游标。首次查询无需传入，后续查询使用上一次返回的 NextToken。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults |
integer |
否 |
本次查询返回的最大记录数。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据对象。 |
||
| RequestId |
string |
请求 ID。 |
ABB39CC3-4488-4857-905D-2E4A051D**** |
| TotalCount |
integer |
符合查询条件的分支总数。 |
20 |
| PageNumber |
integer |
页码。取值需大于 0，默认值为 1。 |
1 |
| PageSize |
integer |
每页记录数。 可选值：
默认值：20。 |
20 |
| Branches |
object |
||
| Branch |
array<object> |
分支列表。每个元素表示一个 Supabase 分支。 |
|
|
array<object> |
返回数据对象。 |
||
| BranchId |
string |
分支 ID，用于唯一标识一个 Supabase 分支。 |
br-xxxx |
| BranchName |
string |
分支名称。 |
dev |
| IsDefault |
boolean |
是否为默认分支。 |
true |
| Description |
string |
分支描述信息。 |
test branch |
| ParentBranchName |
string |
父分支名称。主分支为空或显示为 -。 |
main |
| ParentBranchId |
string |
父分支 ID，用于指定新分支或查询条件的上级分支。 |
br-main |
| ServiceType |
string |
服务类型。 可选值：
|
Supabase |
| ProjectId |
string |
主分支对应的 Supabase 项目 ID。 |
spb-xxxx |
| CreateTime |
string |
分支创建时间，格式为 ISO 8601 UTC 时间。 |
2026-04-08T09:11:12Z |
| Status |
string |
分支状态。 |
Running |
| Tags |
object |
||
| Tag |
array<object> |
分支标签列表。 |
|
|
object |
返回数据对象。 |
||
| Key |
string |
标签键。 |
env |
| Value |
string |
标签值。 |
dev |
| ExpiresAt |
string |
分支过期自动删除时间，格式为 ISO 8601 UTC 时间。 |
2026-10-08T09:11:12Z |
| InitSource |
string |
分支初始化来源。 取值：
|
ParentData |
| Protected |
boolean |
是否开启分支保护。 取值：
|
false |
| ParentTimestamp |
string |
该分支从父分支创建时选择的数据同步时间点，格式为 ISO 8601 UTC 时间。 说明：
|
2026-04-08T09:11:12Z |
| ParentLSN |
string |
该分支创建时对应父分支的 LSN。 |
0/3522648 |
| MaxResults |
integer |
本次查询返回的最大记录数。 |
20 |
| NextToken |
string |
分页查询的游标。首次查询无需传入，后续查询使用上一次返回的 NextToken。 |
caeba0bbb2be03f84eb48b699f0a4883 |
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
"TotalCount": 20,
"PageNumber": 1,
"PageSize": 20,
"Branches": {
"Branch": [
{
"BranchId": "br-xxxx",
"BranchName": "dev",
"IsDefault": true,
"Description": "test branch",
"ParentBranchName": "main",
"ParentBranchId": "br-main",
"ServiceType": "Supabase",
"ProjectId": "spb-xxxx",
"CreateTime": "2026-04-08T09:11:12Z",
"Status": "Running",
"Tags": {
"Tag": [
{
"Key": "env",
"Value": "dev"
}
]
},
"ExpiresAt": "2026-10-08T09:11:12Z",
"InitSource": "ParentData",
"Protected": false,
"ParentTimestamp": "2026-04-08T09:11:12Z",
"ParentLSN": "0/3522648"
}
]
},
"MaxResults": 20,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。