All Products
Search
Document Center

ApsaraDB for ClickHouse:TransferVersion

Last Updated:Nov 12, 2024

Migrates the data of a source ApsaraDB for ClickHouse cluster to a destination ApsaraDB for ClickHouse cluster.

Operation description

Prerequisites

  • The IP address of the source ApsaraDB for ClickHouse cluster is added to the IP address whitelist of the destination ApsaraDB for ClickHouse cluster.
  • The IP address of the destination ApsaraDB for ClickHouse cluster is added to the IP address whitelist of the source ApsaraDB for ClickHouse cluster.
Note You can execute the select * from system.clusters; statement to query the IP address of an ApsaraDB for ClickHouse cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:TransferVersioncreate
  • DBCluster
    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBClusterIdstringYes

The ID of the source ApsaraDB for ClickHouse cluster.

cc-bp1tm8zf130ew****
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30 (default)
  • 50
  • 100
30
PageNumberintegerNo

The page number.

1
TargetDbClusterIdstringYes

The ID of the destination ApsaraDB for ClickHouse cluster.

cc-bp14b39djx7zg****
SourceAccountstringYes

The database account that is used to log on to the database in the source ApsaraDB for ClickHouse cluster.

test
TargetAccountstringYes

The database account that is used to log on to the database in the destination ApsaraDB for ClickHouse cluster.

test01
SourcePasswordstringYes

The password that corresponds to the database account for logging on to the database in the source ApsaraDB for ClickHouse cluster.

123456Aa
TargetPasswordstringYes

The password that corresponds to the database account for logging on to the database in the destination ApsaraDB for ClickHouse cluster.

123456Ff

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7084CDB5-308F-5D0B-8F9B-5F7D83E09738

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.
503ServiceUnavailableAn error occurred while processing your request.An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-24API Description Update. The Error code has changedView Change Details
2024-08-12The Error code has changed. The request parameters of the API has changedView Change Details
2021-07-14The Error code has changed. The response structure of the API has changedView Change Details