CreateRDSToClickhouseDb - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

You can call the CreateRDSToClickhouseDb operation to create a sync task for an ApsaraDB for ClickHouse Community-Compatible Edition cluster.

Operation description

Note

This operation applies only to ApsaraDB for ClickHouse Community-Compatible Edition clusters.

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:CreateRDSToClickhouseDb

create

*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-2ze5zeyl72188****
ClickhousePort	integer	No	The port number of the ApsaraDB for ClickHouse cluster.	8123
CkUserName	string	Yes	The database account of the ApsaraDB for ClickHouse cluster.	user1
CkPassword	string	Yes	The password for the database account of the ApsaraDB for ClickHouse cluster.	123456Aa
RdsId	string	Yes	The ID of the ApsaraDB RDS for MySQL instance.	rm-8vb989qj9roh0****
RdsPort	integer	No	The port number of the ApsaraDB RDS for MySQL instance.	3306
RdsVpcId	string	No	The VPC ID of the ApsaraDB RDS for MySQL instance.	vpc-2zen93xryil99jsfy****
RdsUserName	string	Yes	The database account of the ApsaraDB RDS for MySQL instance.	user2
RdsPassword	string	Yes	The password for the database account of the ApsaraDB RDS for MySQL instance.	123456Rr
SkipUnsupported	boolean	Yes	Specifies whether to skip unsupported table schemas. Valid values: true: Skip. false: Do not skip.	true
LimitUpper	integer	No	The maximum number of rows to sync per second.	50000
SynDbTables	string	Yes	The tables to sync.	[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]
RdsVpcUrl	string	No	The internal endpoint of the ApsaraDB RDS instance.	rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	66676F54-1994-5DCF-993F-74536649628A
Status	integer	Indicates whether the task was created. Valid values: 1: The task was created. 0: The task failed to be created because of duplicate tables. The duplicate tables are returned in the RepeatedDbs parameter. -1: The task failed to be created. The error message is returned in the ErrorMsg parameter.	0
ErrorMsg	string	The reason for the creation failure. This parameter is returned only if the value of the Status parameter is -1.	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	The duplicate tables in the sync task.
	string	The duplicate tables in the sync task. This parameter is returned only if the value of the Status parameter is 0.	["mr_platform_cpm","mr_platform_ecpm"]

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.