DescribeSynDbs - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.

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-bp1ab22b80814****
PageSize	integer	No	The number of entries per page.	20
PageNumber	integer	No	The page number.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7655F5F9-1313-5ABA-8516-F6EB79605A5F
SynDbs	array<object>	The information about data synchronization between the ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.
	object
RdsId	string	The ID of the ApsaraDB RDS for MySQL instance.	rm-wz9d11qg1j0h4****
SynDb	string	The name of the database in the ApsaraDB RDS for MySQL instance.	database
SynStatus	boolean	Indicates whether the data synchronization succeeded. Valid values: true: The data synchronization succeeded. false: The data synchronization failed.	true
ErrorMsg	string	When the value true is returned for the SynStatus parameter, the system does not return the ErrorMsg parameter. When the value false is returned for the SynStatus parameter, the system returns for the ErrorMsg parameter the cause why the data synchronization failed.	ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
RdsUserName	string	The database account that is used to log on to the ApsaraDB RDS for MySQL instance.	test
RdsVpcUrl	string	The internal endpoint of the ApsaraDB RDS for MySQL instance.	rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306
TotalCount	integer	The total number of entries returned.	0
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "7655F5F9-1313-5ABA-8516-F6EB79605A5F",
  "SynDbs": [
    {
      "RdsId": "rm-wz9d11qg1j0h4****",
      "SynDb": "database",
      "SynStatus": true,
      "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
      "RdsUserName": "test",
      "RdsVpcUrl": "rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306"
    }
  ],
  "TotalCount": 0,
  "PageSize": 20,
  "PageNumber": 1
}

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
2023-12-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-12	The Error code has changed. The request parameters of the API has changed	View Change Details