DescribeSynDbs - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries information about synchronized databases.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeSynDbs

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

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 records to return on each page.	20
PageNumber	integer	No	The current page number.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7655F5F9-1313-5ABA-8516-F6EB79605A5F
SynDbs	array<object>	The synchronized data.
	object	The objects synchronized to ClickHouse.
RdsId	string	The instance ID of the ApsaraDB RDS for MySQL instance.	rm-wz9d11qg1j0h4****
SynDb	string	The database in the ApsaraDB RDS for MySQL instance.	database
SynStatus	boolean	Indicates whether the synchronization was successful. Valid values: true: The synchronization was successful. false: The synchronization failed.	true
ErrorMsg	string	This parameter is not returned if SynStatus is true. If SynStatus is false, this parameter indicates the reason for the synchronization failure.	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 for 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 records.	0
PageSize	integer	The number of records on each page.	20
PageNumber	integer	The current page number.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.