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

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
分支管理
DescribeSchemaDiffResultMeta
复制全文
下载 pdf
DescribeSchemaDiffResultMeta
调用 DescribeSchemaDiffResultMeta 查询分支对比任务的详细信息。​
请求类型​
同步请求。​
注意事项​
该接口仅能用于操作使用 PostgreSQL 引擎和 Supabase 引擎的 Workspace(工作区)。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
WorkspaceId​
String​
是​
perky-bean-1459****​
Workspace 的 ID。​
SchemaDiffJobId​
String​
是​
schema-diff-7cf8b8402a17426f8bcef50f62db****​
分支对比任务的 ID。​
PageNum​
Integer​
否​
2​
分页查询 的起始页,可取大于等于 1 的整数值,默认值为 1。​
PageSize​
Integer​
否​
20​
分页查询数量,可取大于等于 1 的整数值,默认值为 10。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
JobBeginTime​
String​
2026-05-11T12:21:58Z​
分支对比任务的开始时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
JobEndTime​
String​
2026-05-11T12:21:58Z​
分支对比任务的结束时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ssZ。​
RequestMessage​
请参见返回示例。​
分支对比任务的请求信息。​
ResponseMessages​
请参见返回示例。​
分支对比任务的详细结果。​
Status​
String​
finished​
支对比任务的状态。​
Total​
Integer​
3​
支对比任务的结果总数。​
​
SchemaDiffRequestObject​
​
参数​
类型​
示例值​
描述​
SourceBranchId​
String​
br-neat-taka-9e46****​
源分支的 ID。​
SourceDatabaseName​
String​
SourceDB​
源数据库的名称。​
SourceSchemaName​
String​
SourceSchema​
源 Schema 的名称。 ​
TargetBranchId​
String​
br-neat-taka-9e46****​
目标分支的 ID。​
TargetDatabaseName​
String​
SourceDB​
目标数据库的名称。​
TargetSchemaName​
String​
br-neat-taka-9e46****​
目标 Schema 的名称。 ​
WorkspaceId​
String​
perky-bean-1459****​
Workspace 的 ID。​
​
SchemaDiffResultMetaObject​
​
参数​
类型​
示例值​
描述​
CompareResultType​
String​
Source Only​
差异类型。取值:​
  • Common:在源 Schema 和目标 Schema 都有该对象,且没有差异。​
  • Different:在源 Schema 和目标 Schema 都有该对象,但定义不同, diff_ddl 有变更内容。​
  • Source Only:只在源 Schema 存在。​
  • Target Only:只在目标 Schema 存在。​
ObjectType​
String​
table​
差异对象的类型。取值:​
  • table:表、列、index、foreign_key、trigger。​
  • sequence:序列。​
  • function:函数。​
  • procedure:程序。​
  • view: 视图。​
  • materialized_view:物化视图。​
  • extension:插件。​
  • enum:枚举。​
SourceObjectName​
String​
SourceSchemaTable2​
源端对象名称。​
SourceSchemaName​
String​
SourceSchema​
源 Schema 的名称。 ​
TargetObjectName​
String​
SourceSchemaTable2​
目标对象名称。​
TargetSchemaName​
String​
DestinationSchema​
目标 Schema 的名称。 ​
​
示例​
请求示例​
​
POST /?Action=DescribeSchemaDiffResultMeta&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": "perky-bean-1459****",​
"SchemaDiffJobId": "schema-diff-7cf8b8402a17426f8bcef50f62db****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260511123357DEB2BB44F27758066D14-5efb5e",​
"Action": "DescribeSchemaDiffResultMeta",​
"Version": "2025-10-01",​
"Service": "aidap",​
"Region": "cn-beijing"​
},​
"Result": {​
"JobBeginTime": "2026-05-11T12:21:58Z",​
"JobEndTime": "2026-05-11T12:21:58Z",​
"RequestMessage": {​
"SourceBranchId": "br-neat-taka-9e46****",​
"SourceDatabaseName": "SourceDB",​
"SourceSchemaName": "SourceSchema",​
"TargetBranchId": "br-neat-taka-9e46****",​
"TargetDatabaseName": "SourceDB",​
"TargetSchemaName": "DestinationSchema",​
"WorkspaceId": "perky-bean-1459c86v"​
},​
"ResponseMessages": [​
{​
"CompareResultType": "Source Only",​
"ObjectType": "table",​
"SourceObjectName": "SourceSchemaTable1",​
"SourceSchemaName": "SourceSchema",​
"TargetObjectName": "SourceSchemaTable1",​
"TargetSchemaName": "DestinationSchema"​
},​
{​
"CompareResultType": "Source Only",​
"ObjectType": "table",​
"SourceObjectName": "SourceSchemaTable2",​
"SourceSchemaName": "SourceSchema",​
"TargetObjectName": "SourceSchemaTable2",​
"TargetSchemaName": "DestinationSchema"​
},​
{​
"CompareResultType": "Target Only",​
"ObjectType": "table",​
"SourceObjectName": "DestinationSchemaName",​
"SourceSchemaName": "SourceSchema",​
"TargetObjectName": "DestinationSchemaName",​
"TargetSchemaName": "DestinationSchema"​
}​
],​
"Status": "finished",​
"Total": 3​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.24 10:58:48
这个页面对您有帮助吗?
有用
有用
无用
无用