All Products
Search

This Product

    ApsaraDB for ClickHouse:ModifyRDSToClickhouseDb

    Document Center

    ApsaraDB for ClickHouse:ModifyRDSToClickhouseDb

    Last Updated:Jul 17, 2024

    Modifies the synchronization task of an ApsaraDB for ClickHouse cluster.

    Operation description

    Note This operation is applicable only to ApsaraDB for ClickHouse clusters.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DbClusterIdstringYes

    The ID of the ApsaraDB for ClickHouse cluster.

    		cc-bp158i5wvj436****
    ClickhousePortlongNo

    The port number of the ApsaraDB for ClickHouse cluster.

    		8123
    CkUserNamestringYes

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

    		user1
    CkPasswordstringYes

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

    		123456Aa
    RdsIdstringYes

    The ID of the ApsaraDB RDS for MySQL instance.

    		rm-uf6x3qq4t90ok****
    RdsPortlongNo

    The port number of the ApsaraDB RDS for MySQL instance.

    		3306
    RdsVpcIdstringNo

    The ID of the virtual private cloud (VPC) to which the ApsaraDB RDS for MySQL instance belongs.

    		vpc-bp1v9dtwmqqjhwwg****
    RdsUserNamestringYes

    The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.

    		user2
    RdsPasswordstringYes

    The password of the account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.

    		123456Rr
    SkipUnsupportedbooleanYes

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

    • true
    • false
    		true
    LimitUpperlongNo

    The maximum number of rows that can be synchronized per second.

    		50000
    RdsSynTablesstringYes

    The table in the ApsaraDB RDS for MySQL instance.

    		table
    RdsSynDbstringYes

    The database in the ApsaraDB RDS for MySQL instance.

    		database

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    Indicates whether the modification was successful. Valid values:

    • 1: The modification was successful.
    • 0: The modification failed.
    		1
    ErrorMsgstring
    • If the value 1 is returned for the Status parameter, the system does not return the ErrorMsg parameter.
    • If the value 0 is returned for the Status parameter, the ErrorMsg parameter returns the cause for the modification failure.
    		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
    ErrorCodelong

    The error code.

    		0

    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 codeError codeError messageDescription
    404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
    No change history