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

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
前端部署
DescribePagesBinding
复制全文
下载 pdf
DescribePagesBinding
调用 DescribePagesBinding 接口查询指定 Workspace/Branch 的 Pages 绑定详情,包括绑定的项目信息和环境变量配置。​
请求类型​
同步请求。​
注意事项​
该接口仅能用于操作使用 Supabase 引擎的 Workspace(工作区)。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
WorkspaceId​
String​
是​
spicy-peach-3f87****​
Workspace 的 ID。​
BranchId​
String​
是​
br-plush-yak-9411****​
分支 ID。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Binding​
Object of PagesBinding​
请参见返回示例。​
Workspace 与 Pages 项目的绑定信息。​
说明​
如 Workspace 未绑定 Pages 项目,则返回空。​
PagesProject​
Object of PagesProjectSummary​
请参见返回示例。​
Workspace 绑定的 Pages 项目的详细信息。​
​
PagesBinding​
​
参数​
类型​
示例值​
描述​
BranchId​
String​
br-plush-yak-9411****​
分支 ID。​
CustomPrefix​
String​
Sample_CustomPrefix_​
自定义的变量前缀。如绑定时未指定 CustomPrefix,则不返回。​
EnvVarNames​
Array of String​
[​
"POSTGRES_DATABASE",​
"POSTGRES_HOST",​
"POSTGRES_PASSWORD",​
"POSTGRES_URL",​
"POSTGRES_USER",​
"SUPABASE_ANON_KEY",​
"SUPABASE_SERVICE_ROLE_KEY",​
"SUPABASE_URL"​
]​
变量名称。取值可为:​
  • SUPABASE_ANON_KEY:Supabase API 的 anon 密钥。 ​
  • SUPABASE_URL:Supabase 服务的访问连接串。 ​
  • SUPABASE_SERVICE_ROLE_KEY:Supabase API 的 service_role 密钥。 ​
  • POSTGRES_URL:完整的数据库连接字符串。格式为 postgresql://用户名:密码@主机:端口/数据库名,一个变量包含所有连接信息。 ​
  • POSTGRES_USER:登录数据库的用户名。 ​
  • POSTGRES_HOST:数据库服务器的地址(IP 或域名)。 ​
  • POSTGRES_PASSWORD:对应用户的登录密码。 ​
  • POSTGRES_DATABASE:要连接的目标数据库的名称。 ​
FrameworkPrefix​
String​
NEXT_PUBLIC_​
自定义的框架变量前缀。​
PagesProjectId​
String​
3x5jww****​
Pages 项目的 ID。​
WorkspaceId​
String​
calm-thyme-1726****​
Pages 项目绑定的 Workspace 的 ID。​
​
PagesProjectSummary​
​
参数​
类型​
示例值​
描述​
CreateTime​
String​
2026-06-11T09:42:16Z​
项目的创建时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
CustomDomains​
Array of String​
example.com​
Pages 项目的自定义域名。 ​
说明​
如未指定,则不返回该字段。​
HasSupabaseBinding​
Boolean​
true​
Pages 项目是否绑定了 Workspace。​
LatestDeploy​
String​
xedymh****​
最近一次部署的 ID。​
PagesProjectId​
String​
3x5jww****​
Pages 项目的 ID。​
PagesProjectName​
String​
TestPagesProject​
Pages 项目的名称。​
PreviewDomain​
String​
TestPagesProject-3x5jww****-projpcihtafokauy3ujz.boe-preivew.iga-pages.com​
Pages 项目的预览域名。​
Status​
String​
DeploySuccess​
Pages 项目的状态。​
SupabaseBindings​
Array of PagesBinding​
请参见返回示例。​
Pages 项目的名称。​
UpdateTime​
String​
2026-06-11T09:49:09Z​
项目的更新时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
​
示例​
请求示例​
​
POST /?Action=DescribePagesBinding&Version=2025-10-01​
Content-Type: application/json​
Host: aidap.cn-beijing.volcengineapi.com​
X-Date: 20251001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20251001/cn-beijing/aidap/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"WorkspaceId": "spicy-peach-3f87****",​
"BranchId": "br-plush-yak-9411****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribePagesBinding",​
"Version": "2025-10-01",​
"Service": "aidap",​
"Region": "cn-beijing"​
},​
"Result": {​
"Binding": {​
"BranchId": "br-holy-koi-996f****",​
"EnvVarNames": [​
"POSTGRES_DATABASE",​
"POSTGRES_HOST",​
"POSTGRES_PASSWORD",​
"POSTGRES_URL",​
"POSTGRES_USER",​
"SUPABASE_ANON_KEY",​
"SUPABASE_SERVICE_ROLE_KEY",​
"SUPABASE_URL"​
],​
"FrameworkPrefix": "NEXT_PUBLIC_",​
"PagesProjectId": "3x5jw****",​
"WorkspaceId": "calm-thyme-1726****"​
},​
"PagesProject": {​
"CreateTime": "2026-06-11T09:42:16Z",​
"HasSupabaseBinding": true,​
"LatestDeploy": "4ym0mdj3xj",​
"PagesProjectId": "3x5jw****",​
"PagesProjectName": "TestPagesProject",​
"PreviewDomain": "http://TestPagesProject-3x5jww****-4ym0md****.preivew.iga-pages.com?iga_token=28885056882174ec600bcb955537****&iga_time=1781192016",​
"Status": "DeploySuccess",​
"SupabaseBindings": [​
{​
"BranchId": "br-holy-koi-996f****",​
"EnvVarNames": [​
"POSTGRES_DATABASE",​
"POSTGRES_HOST",​
"POSTGRES_PASSWORD",​
"POSTGRES_URL",​
"POSTGRES_USER",​
"SUPABASE_ANON_KEY",​
"SUPABASE_SERVICE_ROLE_KEY",​
"SUPABASE_URL"​
],​
"FrameworkPrefix": "NEXT_PUBLIC_",​
"PagesProjectId": "3x5jww****",​
"WorkspaceId": "calm-thyme-1726****"​
}​
],​
"UpdateTime": "2026-06-11T09:49:09Z"​
}​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.24 10:58:49
这个页面对您有帮助吗?
有用
有用
无用
无用