CreateRDSToClickhouseDb - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Creates a task to synchronize data from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.

Operation description

Note This operation is only applicable to ApsaraDB for ClickHouse clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DbClusterId	string	Yes	The ID of the ApsaraDB for ClickHouse cluster.	cc-2ze5zeyl72188****
ClickhousePort	long	No	The port number of the ApsaraDB for ClickHouse cluster.	8123
CkUserName	string	Yes	The account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.	user1
CkPassword	string	Yes	The password of the account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.	123456Aa
RdsId	string	Yes	The ID of the ApsaraDB RDS for MySQL instance.	rm-8vb989qj9roh0****
RdsPort	long	No	The port number of the ApsaraDB RDS for MySQL instance.	3306
RdsVpcId	string	No	The ID of the virtual private cloud (VPC) to which the ApsaraDB RDS for MySQL instance belongs.	vpc-2zen93xryil99jsfy****
RdsUserName	string	Yes	The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.	user2
RdsPassword	string	Yes	The password of the account that is used to log on to the ApsaraDB RDS for MySQL instance.	123456Rr
SkipUnsupported	boolean	Yes	Specifies whether to ignore the table schemas that do not support synchronization. Valid values: true false	true
LimitUpper	long	No	The maximum number of rows that can be synchronized per second.	50000
SynDbTables	string	Yes	The tables whose data you want to synchronize.	[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]
RdsVpcUrl	string	No	The private endpoint of the ApsaraDB RDS for MySQL instance.	rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	66676F54-1994-5DCF-993F-74536649628A
Status	long	Indicates whether the synchronization task was created. Valid values: 1: Created. 0: Creation failed. The tables in the synchronization task are duplicate. The duplicate tables are returned for the RepeatedDbs parameter. -1: Creation failed. The cause why the creation failed is returned for the ErrorMsg parameter.	0
ErrorMsg	string	If -1 is returned for the Status parameter, the cause of the creation failure is returned.	ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
RepeatedDbs	array	Duplicate tables in the synchronization task.
	string	If 0 is returned for the Status parameter, duplicate tables are returned.	["mr_platform_cpm","mr_platform_ecpm"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "66676F54-1994-5DCF-993F-74536649628A",
  "Status": 0,
  "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
  "RepeatedDbs": [
    "[\"mr_platform_cpm\",\"mr_platform_ecpm\"]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history