Skip to main content

Add DataSource

Interface Overview

Add datasource information.

Interface Address

/cloudcanal/console/api/v1/openapi/datasource/addds

Request Manner

POST

Request Parameters

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
dataSourceAddDataData source configuration in standard JSON formatBodyTrueString
securityFileSecurity file, such as the truststore file for SSL or the krb5 file for KerberosBodyFalseMultipartFile
secretFileSecret file, such as the username/password file for jaas or the keytab file for KerberosBodyFalseMultipartFile

DataSourceAddData Indicates the parameter description

ParameterNameParameter DescriptionType(Java)NotNull
deployTypeData source deployment type

SELF_MAINTENANCE (self-built)
ALIBABA_CLOUD_HOSTED (Alibaba Cloud)
StringTrue
regionData source region

hangzhou
shanghai
beijing
shenzhen
qingdao
zhangjiakou
huhehaote
hongkong
singapore
silicon_valley
london
mq_internet_access
customer
StringTrue
typeData source type

MySQL
PolarDbMySQL
PolarDbX
PostgreSQL
Greenplum
Oracle
SQLServer
Redis
MongoDB
Kafka
RocketMQ
RabbitMQ
Hive
ElasticSearch
DRDS
AdbForMySQL
TiDB
ClickHouse
Kudu
StringTrue
hostTypeDefault network type

PRIVATE (intranet)
PUBLIC (public network)
StringTrue
privateHostIntranet hostStringDepending on hostType
publicHostPublic network hostStringDepending on hostType
securityTypeSecurity key type

KERBEROS
USER_PASSWD_WITH_TLS
USER_PASSWD
ONLY_USER
ONLY_PASSWD
NONE
StringTrue
accountAccountStringDepending on securityType
passwordPasswordStringDepending on securityType
instanceDescData source descriptionStringFalse
instanceIdAlibaba Cloud instance IDStringFalse
accessKeyAlibaba Cloud access keyStringFalse
secretKeyAlibaba Cloud secret keyStringFalse
clientTrustStorePasswordTruststore file password when security key type is USER_PASSWD_WITH_TLSStringFalse
versionDatabase versionStringFalse
connectTypeConnection type, currently only valid for Oracle

ORACLE_SID
ORACLE_SERVICE
ORACLE_TNS
ORACLE_PDB
StringFalse

Public Response Results

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

Data Parameters

The data is a number that indicates the data source id that was successfully added.

Response Example

{
"requestId": "422622b9-2bf5-11ec-8b3e-172e4c81a5c3",
"code": "1",
"msg": "request success",
"data": 123243
}