TransferVersion - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Migration between versions.

Operation description

Prerequisites

Add the IP addresses of the source cluster to the whitelist of the destination cluster.
Add the IP addresses of the destination cluster to the whitelist of the source cluster.

Note

You can execute the select * from system.clusters; statement to retrieve the IP addresses of an ApsaraDB for ClickHouse cluster.

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

create

*DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. Call the DescribeRegions operation to query the most recent list of regions.	cn-hangzhou
DBClusterId	string	Yes	The ID of the source cluster.	cc-bp1tm8zf130ew****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	No	The page number.	1
TargetDbClusterId	string	Yes	The ID of the destination cluster.	cc-bp14b39djx7zg****
SourceAccount	string	Yes	The source account.	test
TargetAccount	string	Yes	The destination account.	test01
SourcePassword	string	Yes	The password of the source account.	123456Aa
TargetPassword	string	Yes	The password of the destination account.	123456Ff
DisableWriteWindows	string	No	The time windows during which writes are disabled.	2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
SourceClusterName	string	No	The name of the self-managed ClickHouse cluster. To obtain the name, execute `SELECT * FROM system.clusters`.	default
SourceShards	string	No	The addresses and TCP ports of the shards in the self-managed ClickHouse cluster.	192.168.0.4:9000,192.168.0.5:9000,192.168.0.6:9000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7084CDB5-308F-5D0B-8F9B-5F7D83E09738

Examples

Success response

JSON format

{
  "RequestId": "7084CDB5-308F-5D0B-8F9B-5F7D83E09738"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.