All Products
Search

This Product

    AnalyticDB:DescribeSyncAvailableDBClusterList

    Document Center

    AnalyticDB:DescribeSyncAvailableDBClusterList

    Last Updated:Aug 28, 2026

    Queries instances or clusters available for data synchronization.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-4690g37929****
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    QueryType

    string

    Yes

    The query type.

    Valid values:

    • Target

    • Source

    Valid values:

    • Target :

      Target

    • Source :

      Source

    Source
    SourceDBCluster

    array<object>

    No

    The source instances or clusters.

    object

    No

    The source instance or cluster.

    Type

    string

    No

    The database type of the source instance or cluster.

    Valid values:

    • rds: ApsaraDB RDS.

    • sls: Simple Log Service.

    • polardb: PolarDB.

    Valid values:

    • rds :

      rds

    • sls :

      sls

    • polardb :

      polardb

    rds
    ClusterIds

    string

    No

    The ID of the source instance or cluster. Separate multiple IDs with commas (,).

    rm-bp1l3yh04y7us147n
    RegionId

    string

    No

    The region ID.

    cn-hangzhou
    SyncPlatform

    string

    No

    The synchronization platform.

    ADB-CDC

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    FBD1DD96-AD1D-516C-9D9A-60BA081F66EE
    SyncAvailableDBClusters

    array<object>

    The queried instances or clusters.

    object

    The queried instance or cluster.

    TableNumber

    integer

    The number of tables.

    100
    DBClusterId

    string

    The instance or cluster ID.

    rm-bp1l3yh04y7us147n
    DBClusterDescription

    string

    The description of the instance or cluster.

    DB1
    DBType

    string

    The database type of the instance or cluster.

    rds
    StorageSize

    number

    The storage size.

    1000

    Examples

    Success response

    JSON format

    {
  "RequestId": "FBD1DD96-AD1D-516C-9D9A-60BA081F66EE",
  "SyncAvailableDBClusters": [
    {
      "TableNumber": 100,
      "DBClusterId": "rm-bp1l3yh04y7us147n",
      "DBClusterDescription": "DB1",
      "DBType": "rds",
      "StorageSize": 1000
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError An error occurred while processing your request. An internal error occurred. Please try again later.
    503 ServiceUnavailable An error occurred while processing your request. The system is unavailable. Please try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.