All Products
Search

This Product

    ApsaraDB for ClickHouse:CheckClickhouseToRDS

    Document Center

    ApsaraDB for ClickHouse:CheckClickhouseToRDS

    Last Updated:Dec 04, 2025

    Call the CheckClickhouseToRDS operation to verify the connectivity between a community-compatible ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.

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

    get

    *DBCluster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DbClusterId

    string

    Yes

    The ID of the community-compatible ApsaraDB for ClickHouse cluster.

    cc-2zeyy362b5sbm****
    ClickhousePort

    integer

    No

    The port number of the ApsaraDB for ClickHouse cluster.

    8123
    CkUserName

    string

    Yes

    The database account for the ApsaraDB for ClickHouse cluster.

    user1
    CkPassword

    string

    Yes

    The password for the ApsaraDB for ClickHouse database account.

    123456Aa
    RdsId

    string

    Yes

    The ID of the ApsaraDB RDS instance.

    rm-bp13v4bnwlu8j****
    RdsPort

    integer

    No

    The port number of the ApsaraDB RDS instance.

    3306
    RdsVpcId

    string

    Yes

    The VPC ID of the ApsaraDB RDS instance.

    vpc-wz9mm0qka0winfl47****
    RdsUserName

    string

    Yes

    The database account for the ApsaraDB RDS instance.

    user2
    RdsPassword

    string

    Yes

    The password for the ApsaraDB RDS database account.

    123456Rr
    RdsVpcUrl

    string

    Yes

    The internal endpoint of the ApsaraDB RDS instance.

    rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    A82758F8-E793-5610-BE11-0E46664305C2
    Status

    boolean

    Indicates whether a connection can be established. Valid values:

    • true: A connection can be established.

    • false: A connection cannot be established.

    false
    ErrorCode

    string

    • This parameter is returned only if the connection fails (Status is false).

    • It indicates the reason for the connection failure.

    NotSameVpc

    Examples

    Success response

    JSON format

    {
  "RequestId": "A82758F8-E793-5610-BE11-0E46664305C2",
  "Status": false,
  "ErrorCode": "NotSameVpc"
}

    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.