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
| ParameterName | Parameter Description | RequestType | Whether Required | DataType |
|---|---|---|---|---|
| srcDsType | Source Data Source Type MySQL PolarDbMySQL PolarDbX PostgreSQL Greenplum Oracle SQLServer Redis MongoDB Kafka RocketMQ RabbitMQ Hive ElasticSearch DRDS AdbForMySQL TiDB ClickHouse Kudu | Body | True | String |
| dstDsType | Destination Data Source Type MySQL PolarDbMySQL PolarDbX PostgreSQL Greenplum Oracle SQLServer Redis MongoDB Kafka RocketMQ RabbitMQ Hive ElasticSearch DRDS AdbForMySQL TiDB ClickHouse Kudu | Body | True | String |
Public Response Results
| ParameterName | Parameter Description | Type(Java) | NotNull |
|---|---|---|---|
| code | 1: Success 0: Failure | String | True |
| data | Object | False | |
| msg | String | False | |
| requestId | String | True |
Data Parameters
The "data" has an array called "dsMappingInfo" with the following item descriptions:
| ParameterName | Parameter Description | Type(Java) | NotNull |
|---|---|---|---|
| method | Mapping Rule Name | String | True |
| srcParents | Source Metadata Parent Node Information Optional values include: DB SCHEMA TABLE COLUMN TOPIC INDEX | List | True |
| dstParents | Destination Metadata Parent Node Information Optional values include: DB SCHEMA TABLE COLUMN TOPIC INDEX | List | True |
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"
]
}
]
}