Skip to main content

Mapping Meta

Interface Overview

Obtain the data source mapping information for selection when creating a task.

Interface Address

/cloudcanal/console/api/v1/openapi/constant/dsmappingmeta

Request Manner

POST

Request Parameters

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
srcDsTypeSource Data Source Type

MySQL
PolarDbMySQL
PolarDbX
PostgreSQL
Greenplum
Oracle
SQLServer
Redis
MongoDB
Kafka
RocketMQ
RabbitMQ
Hive
ElasticSearch
DRDS
AdbForMySQL
TiDB
ClickHouse
Kudu
BodyTrueString
dstDsTypeDestination Data Source Type

MySQL
PolarDbMySQL
PolarDbX
PostgreSQL
Greenplum
Oracle
SQLServer
Redis
MongoDB
Kafka
RocketMQ
RabbitMQ
Hive
ElasticSearch
DRDS
AdbForMySQL
TiDB
ClickHouse
Kudu
BodyTrueString

Public Response Results

ParameterNameParameter DescriptionType(Java)NotNull
code1: Success
0: Failure
StringTrue
dataObjectFalse
msgStringFalse
requestIdStringTrue

Data Parameters

The "data" has an array called "dsMappingInfo" with the following item descriptions:

ParameterNameParameter DescriptionType(Java)NotNull
methodMapping Rule NameStringTrue
srcParentsSource Metadata Parent Node Information
Optional values include:
DB
SCHEMA
TABLE
COLUMN
TOPIC
INDEX
ListTrue
dstParentsDestination Metadata Parent Node Information
Optional values include:
DB
SCHEMA
TABLE
COLUMN
TOPIC
INDEX
ListTrue

Response Example

{
"requestId": "c00aa078-2cb4-11ec-a410-6990afdaac21",
"code": "1",
"msg": "request success",
"data": [
{
"method": "DB_SCHEMA",
"srcParents": [],
"dstParents": [
"DB"
]
},
{
"method": "TABLE_TABLE",
"srcParents": [
"DB"
],
"dstParents": [
"SCHEMA",
"DB"
]
},
{
"method": "COLUMN_COLUMN",
"srcParents": [
"TABLE",
"DB"
],
"dstParents": [
"TABLE",
"SCHEMA",
"DB"
]
}
]
}