CheckClickhouseToRDS - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Checks the connectivity between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.

Debugging

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
DbClusterId	string	Yes	The ID of the ApsaraDB for ClickHouse cluster.	cc-2zeyy362b5sbm****
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-bp13v4bnwlu8j****
RdsPort	long	No	The port number of the ApsaraDB RDS for MySQL instance.	3306
RdsVpcId	string	Yes	The ID of the VPC in which the ApsaraDB RDS for MySQL instance is deployed.	vpc-wz9mm0qka0winfl47****
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 database in the ApsaraDB RDS for MySQL instance.	123456Rr
RdsVpcUrl	string	Yes	The internal endpoint of the ApsaraDB RDS for MySQL instance.	rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A82758F8-E793-5610-BE11-0E46664305C2
Status	boolean	Indicates whether the ApsaraDB for ClickHouse cluster can be connected to the ApsaraDB RDS for MySQL instance. true: The ApsaraDB for ClickHouse cluster can be connected to the ApsaraDB RDS for MySQL instance. false: The ApsaraDB for ClickHouse cluster cannot be connected to the ApsaraDB RDS for MySQL instance.	false
ErrorCode	string	When the value true is returned for the Status parameter, the system does not return the ErrorCode parameter. When the value false is returned for the Status parameter, the system returns for the ErrorCode parameter the reason why the ApsaraDB for ClickHouse cluster cannot be connected to the ApsaraDB RDS for MySQL instance.	NotSameVpc

Sample success responses

JSONformat

{
  "RequestId": "A82758F8-E793-5610-BE11-0E46664305C2",
  "Status": false,
  "ErrorCode": "NotSameVpc"
}

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 time	Summary of changes	Operation

No change history