Skip to main content

DataSource Charset

Interface Overview

Obtain the data source code for selecting when creating a task.

Interface Address

/cloudcanal/console/api/v1/openapi/constant/dscharsetoptions

Request Manner

POST

Request Parameters

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
dataSourceTypeData 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 "dsCharsetOptions" with the following item descriptions:

ParameterNameParameter DescriptionType(Java)NotNull
dsCharsetCharacter Encoding NameStringTrue
defaultCheckedWhether to Select by DefaultBooleanTrue

Response Example

{
"requestId": "dd47ac5c-2cb4-11ec-a410-b3030910f280",
"code": "1",
"msg": "request success",
"data": {
"dsCharsetOptions": [
{
"defaultChecked": true,
"dsCharset": "utf8mb4"
},
{
"defaultChecked": false,
"dsCharset": "utf8"
},
{
"defaultChecked": false,
"dsCharset": "gbk"
}
]
}
}