跳到主要内容

查询同步对象

接口描述

根据源端和目标端的数据库、Schema、表名等元数据信息查询同步对象列表,用于血缘分析和对象追溯

接口地址

/cloudcanal/console/api/v1/openapi/schema/listTransObjsByMeta

请求方式

POST

请求参数

参数名称参数说明请求类型是否必须数据类型
srcDb源端数据库名bodystring
srcSchema源端 Schema 名bodystring
srcTransObj源端同步对象名(表名/Topic名等)bodystring
dstDb目标端数据库名bodystring
dstSchema目标端 Schema 名bodystring
dstTranObj目标端同步对象名(表名/Topic名等)bodystring

公共响应结果

参数名称参数说明类型(java)不为空
code1:成功 0:失败string
dataarray
msgstring
requestIdstring

data 参数说明

data 为数组,每个元素为一个同步对象索引信息:

基本信息

参数名称参数说明不为空数据类型
id索引idlong
dataJobId所属 DataJob idlong
dataJobName所属 DataJob 名称string
dataJobDesc所属 DataJob 描述string

源端信息

参数名称参数说明不为空数据类型
srcTransferObjName源端同步对象名string
srcDsInstanceId源端数据源实例IDlong
srcDsInstanceName源端数据源实例名称string
srcFullTransferObjName源端完整对象名(包含库名/Schema名)string
srcDsType源端数据源类型string
srcDb源端数据库名string
srcSchema源端 Schema 名string

目标端信息

参数名称参数说明不为空数据类型
dstTransferObjName目标端同步对象名string
dstDsInstanceId目标端数据源实例IDlong
dstDsInstanceName目标端数据源实例名称string
dstFullTransferObjName目标端完整对象名(包含库名/Schema名)string
dstDsType目标端数据源类型string
dstDb目标端数据库名string
dstSchema目标端 Schema 名string

其他信息

参数名称参数说明不为空数据类型
filterExpr过滤表达式string
specifiedPks指定的主键列string

响应示例

{
"code": "1",
"msg": "request success",
"data":
[
{
"id": 6000,
"srcTransferObjName": "my_table",
"srcDsInstanceId": 100,
"srcDsInstanceName": "my-70o0i0ioc2a004y",
"srcFullTransferObjName": "`from_my`.`my_table`",
"srcDsType": "MySQL",
"srcDb": "from_my",
"srcSchema": null,
"filterExpr": null,
"specifiedPks": null,
"dstTransferObjName": "my_table",
"dstDsInstanceId": 159,
"dstDsInstanceName": "sr-79838690nickf53",
"dstFullTransferObjName": "`from_my`.`my_table`",
"dstDsType": "StarRocks",
"dstDb": "from_my",
"dstSchema": null,
"dataJobId": 271,
"dataJobName": "canaldhm45mo4w6h",
"dataJobDesc": ""
},
{
"id": 6001,
"srcTransferObjName": "w_company",
"srcDsInstanceId": 100,
"srcDsInstanceName": "my-70o0i0ioc2a004y",
"srcFullTransferObjName": "`from_my`.`w_company`",
"srcDsType": "MySQL",
"srcDb": "from_my",
"srcSchema": null,
"filterExpr": null,
"specifiedPks": null,
"dstTransferObjName": "w_company",
"dstDsInstanceId": 159,
"dstDsInstanceName": "sr-79838690nickf53",
"dstFullTransferObjName": "`from_my`.`w_company`",
"dstDsType": "StarRocks",
"dstDb": "from_my",
"dstSchema": null,
"dataJobId": 271,
"dataJobName": "canaldhm45mo4w6h",
"dataJobDesc": ""
},
{
"id": 6002,
"srcTransferObjName": "worker_stats",
"srcDsInstanceId": 100,
"srcDsInstanceName": "my-70o0i0ioc2a004y",
"srcFullTransferObjName": "`from_my`.`worker_stats`",
"srcDsType": "MySQL",
"srcDb": "from_my",
"srcSchema": null,
"filterExpr": null,
"specifiedPks": null,
"dstTransferObjName": "worker_stats",
"dstDsInstanceId": 159,
"dstDsInstanceName": "sr-79838690nickf53",
"dstFullTransferObjName": "`from_my`.`worker_stats`",
"dstDsType": "StarRocks",
"dstDb": "from_my",
"dstSchema": null,
"dataJobId": 271,
"dataJobName": "canaldhm45mo4w6h",
"dataJobDesc": ""
},
{
"id": 6003,
"srcTransferObjName": "workflow_version",
"srcDsInstanceId": 100,
"srcDsInstanceName": "my-70o0i0ioc2a004y",
"srcFullTransferObjName": "`from_my`.`workflow_version`",
"srcDsType": "MySQL",
"srcDb": "from_my",
"srcSchema": null,
"filterExpr": null,
"specifiedPks": null,
"dstTransferObjName": "workflow_version",
"dstDsInstanceId": 159,
"dstDsInstanceName": "sr-79838690nickf53",
"dstFullTransferObjName": "`from_my`.`workflow_version`",
"dstDsType": "StarRocks",
"dstDb": "from_my",
"dstSchema": null,
"dataJobId": 271,
"dataJobName": "canaldhm45mo4w6h",
"dataJobDesc": ""
}
],
"fail": false,
"success": true
}
联系我们
微信二维码

扫码添加微信,获取技术支持