Modifies the synchronization task of an ApsaraDB for ClickHouse cluster.
Operation description
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| clickhouse:ModifyRDSToClickhouseDb | update | *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-bp158i5wvj436**** |
| ClickhousePort | long | No | The port number of the ApsaraDB for ClickHouse cluster. | 8123 |
| CkUserName | string | Yes | The account that is used to log on to the database in the ApsaraDB for ClickHouse cluster. | user1 |
| CkPassword | string | Yes | The password of the account that is used to log on to the database in the ApsaraDB for ClickHouse cluster. | 123456Aa |
| RdsId | string | Yes | The ID of the ApsaraDB RDS for MySQL instance. | rm-uf6x3qq4t90ok**** |
| RdsPort | long | No | The port number of the ApsaraDB RDS for MySQL instance. | 3306 |
| RdsVpcId | string | No | The ID of the virtual private cloud (VPC) to which the ApsaraDB RDS for MySQL instance belongs. | vpc-bp1v9dtwmqqjhwwg**** |
| RdsUserName | string | Yes | The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance. | user2 |
| RdsPassword | string | Yes | The password of the account that is used to log on to the database in the ApsaraDB RDS for MySQL instance. | 123456Rr |
| SkipUnsupported | boolean | Yes | Specifies whether to ignore databases that do not support synchronization. Valid values:
| true |
| LimitUpper | long | No | The maximum number of rows that can be synchronized per second. | 50000 |
| RdsSynTables | string | Yes | The table in the ApsaraDB RDS for MySQL instance. | table |
| RdsSynDb | string | Yes | The database in the ApsaraDB RDS for MySQL instance. | database |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "746CD303-0B82-5E8D-886D-93A9FAF3A876",
"Status": 1,
"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",
"ErrorCode": 0
}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 |
|---|