DescribeSyncAvailableDBClusterList - AnalyticDB - Alibaba Cloud Documentation Center

Queries a list of instances or clusters that are available for data synchronization.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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	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.	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	FBD1DD96-AD1D-516C-9D9A-60BA081F66EE
SyncAvailableDBClusters	array<object>	The queried instances or clusters.
SyncAvailableDBCluster	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	float	The storage size.	1000

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history