DescribeCdcInfo - 查询CDC实例信息 - 云原生数据库 PolarDB

查询CDC信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeCdcInfo

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域	cn-beijing
DBInstanceName	string	是	实例名	pxc-********

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	9B2F3840-5C98-475C-B269-2D5C3A31797C
HttpStatusCode	integer	请求状态码	200
Success	boolean	请求是否成功	true
Data	object	实例数据
CdcNewVersion	string	cdc 最新版本	polarx-cdc-kernel-***
BinlogSize	integer	binlog 大小	524288000
ServerId	integer	server id	3014767486
CheckSumSwitch	string	check sum 开关	ON
VersionSupportMultiCdc	boolean	是否支持 cdc 多流	true
BinlogPersistTime	integer	binlog 保存的天数	15
InstanceTopologyList	array<object>	实例列表
	array<object>
InstanceName	string	实例名	pxc-***
Comment	string	实例类型备注	***
PhysicalNodes	array<object>	节点数组
	object
Disk	integer	磁盘大小，MB	204800
NodeClass	string	实例规格	polarx.x4.large.2e.cdc
Version	string	实例版本	polarx-cdc-kernel-***
AZone	string	实例所在可用区	cn-hangzhou-h
Status	string	实例状态	ACTIVATION
NodeId	string	节点 id	***
NodeName	string	节点的名称。	pxc-c-***
GroupName	string	多流流组名称	test
HashLevel	string	拆分级别	RECORD
StreamNum	integer	拆分数量	2
ClusterType	string	集群类型	BINLOG_X
EnableCyclicReplication	boolean	支持双向复制	true

示例

正常返回示例

JSON格式

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "HttpStatusCode": 200,
  "Success": true,
  "Data": {
    "CdcNewVersion": "polarx-cdc-kernel-***",
    "BinlogSize": 524288000,
    "ServerId": 3014767486,
    "CheckSumSwitch": "ON",
    "VersionSupportMultiCdc": true,
    "BinlogPersistTime": 15,
    "InstanceTopologyList": [
      {
        "InstanceName": "pxc-***",
        "Comment": "***",
        "PhysicalNodes": [
          {
            "Disk": 204800,
            "NodeClass": "polarx.x4.large.2e.cdc",
            "Version": "polarx-cdc-kernel-***",
            "AZone": "cn-hangzhou-h",
            "Status": "ACTIVATION",
            "NodeId": "***",
            "NodeName": "pxc-c-***"
          }
        ],
        "GroupName": "test",
        "HashLevel": "RECORD",
        "StreamNum": 2,
        "ClusterType": "BINLOG_X"
      }
    ],
    "EnableCyclicReplication": true
  }
}

错误码

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

变更历史

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