All Products
Search

This Product

    ApsaraDB for ClickHouse:ModifyRDSToClickhouseDb

    Document Center

    ApsaraDB for ClickHouse:ModifyRDSToClickhouseDb

    Last Updated:Dec 05, 2025

    Modifies the sync task of a community-compatible ApsaraDB for ClickHouse cluster.

    Operation description

    Note

    This operation applies only to community-compatible ApsaraDB for ClickHouse 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:ModifyRDSToClickhouseDb

    update

    *DBCluster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DbClusterId

    string

    Yes

    The ID of the ApsaraDB for ClickHouse cluster.

    cc-bp158i5wvj436****
    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 of the ApsaraDB for ClickHouse database account.

    123456Aa
    RdsId

    string

    Yes

    The instance ID of the ApsaraDB RDS for MySQL instance.

    rm-uf6x3qq4t90ok****
    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-bp1v9dtwmqqjhwwg****
    RdsUserName

    string

    Yes

    The database account of the ApsaraDB RDS for MySQL instance.

    user2
    RdsPassword

    string

    Yes

    The password of the ApsaraDB RDS for MySQL database account.

    123456Rr
    SkipUnsupported

    boolean

    Yes

    Specifies whether to ignore databases that do not support synchronization. Valid values:

    • true: Ignore the databases.

    • false: Do not ignore the databases.

    true
    LimitUpper

    integer

    No

    The maximum number of rows to sync per second.

    50000
    RdsSynTables

    string

    Yes

    The tables in the ApsaraDB RDS for MySQL instance.

    table
    RdsSynDb

    string

    Yes

    The database in the ApsaraDB RDS for MySQL instance.

    database

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned result.

    RequestId

    string

    The request ID.

    746CD303-0B82-5E8D-886D-93A9FAF3A876
    Status

    integer

    Indicates whether the modification was successful. Valid values:

    • 1: The modification was successful.

    • 0: The modification failed.

    1
    ErrorMsg

    string

    • This parameter is not returned if Status is 1.

    • If Status is 0, this parameter indicates the reason why the modification failed.

    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

    integer

    The error code.

    0

    Examples

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.