调用DescribeSynDbs查看同步db_云数据库 ClickHouse-阿里云帮助中心

查看同步db。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:DescribeSynDbs

get

*DBCluster

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

无

请求参数

名称	类型	必填	描述	示例值
DbClusterId	string	是	云数据库 ClickHouse 的集群 ID。	cc-bp1ab22b80814****
PageSize	integer	否	每页记录数。	20
PageNumber	integer	否	当前页码。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7655F5F9-1313-5ABA-8516-F6EB79605A5F
SynDbs	array<object>	同步数据。
	object	同步到 ClickHouse 的对象。
RdsId	string	云数据库 RDS MySQL 的实例 ID。	rm-wz9d11qg1j0h4****
SynDb	string	云数据库 RDS MySQL 的数据库。	database
SynStatus	boolean	同步是否成功，取值说明： true：同步成功。 false：同步失败。	true
ErrorMsg	string	当 SynStatus 返回为 true 时，不返回该参数。当 SynStatus 返回为 false 时，表示同步失败的原因。	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	string	云数据库 RDS MySQL 的数据库账号。	test
RdsVpcUrl	string	云数据库 RDS MySQL 的内网连接地址。	rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306
TotalCount	integer	总记录数。	0
PageSize	integer	每页记录数。	20
PageNumber	integer	当前页码。	1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。