All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeSynDbs

Last Updated:Nov 12, 2024

Queries the information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeSynDbsget
  • DBCluster
    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DbClusterIdstringYes

The ID of the ApsaraDB for ClickHouse cluster.

cc-bp1ab22b80814****
PageSizeintegerNo

The number of entries per page.

20
PageNumberintegerNo

The page number.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7655F5F9-1313-5ABA-8516-F6EB79605A5F
SynDbsarray<object>

The information about data synchronization between the ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.

SynDbobject
RdsIdstring

The ID of the ApsaraDB RDS for MySQL instance.

rm-wz9d11qg1j0h4****
SynDbstring

The name of the database in the ApsaraDB RDS for MySQL instance.

database
SynStatusboolean

Indicates whether the data synchronization succeeded. Valid values:

  • true: The data synchronization succeeded.
  • false: The data synchronization failed.
true
ErrorMsgstring
  • When the value true is returned for the SynStatus parameter, the system does not return the ErrorMsg parameter.
  • When the value false is returned for the SynStatus parameter, the system returns for the ErrorMsg parameter the cause why the data synchronization 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
RdsUserNamestring

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

test
RdsVpcUrlstring

The internal endpoint of the ApsaraDB RDS for MySQL instance.

rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306
TotalCountinteger

The total number of entries returned.

0
PageSizeinteger

The number of entries per page.

20
PageNumberinteger

The page number.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "7655F5F9-1313-5ABA-8516-F6EB79605A5F",
  "SynDbs": [
    {
      "RdsId": "rm-wz9d11qg1j0h4****",
      "SynDb": "database",
      "SynStatus": true,
      "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",
      "RdsUserName": "test",
      "RdsVpcUrl": "rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306"
    }
  ],
  "TotalCount": 0,
  "PageSize": 20,
  "PageNumber": 1
}

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
2023-12-13The Error code has changed. The response structure of the API has changedView Change Details
2023-12-12The Error code has changed. The request parameters of the API has changedView Change Details