AI 助理
备案控制台
文档
输入文档关键字查找
首页 云原生数据库 PolarDB 开发参考 PolarDB分布式版API参考 2.0（2020版本） 实例管理 DescribeDBInstanceTopology

DescribeDBInstanceTopology

更新时间：
产品详情
相关技术圈
我的收藏

调用DescribeDBInstanceTopology接口获取实例拓扑信息。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeDBInstanceTopology

系统规定参数。取值：DescribeDBInstanceTopology。
RegionId String 是 cn-hangzhou

实例所属的地域ID。
DBInstanceName String 是 pxc-********

实例ID。
StartTime String 否 2021-10-21T10:30:45Z 04:00:00

查询拓扑中历史实例范围开始时间，格式为yyyy-MM-dd HH:mm:ss。
EndTime String 否 2021-10-22T10:30:45Z 04:00:00

查询拓扑中历史实例范围结束时间，格式为yyyy-MM-dd HH:mm:ss。

返回数据

名称

类型

示例值

描述
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

请求ID。
Data Object

数据结构体。
LogicInstanceTopology Object

拓扑信息。
DBInstanceName String pxc-sprcym7g7w****

实例名称。
DBInstanceCreateTime String 2021-10-21T10:30:45Z 04:00:00

实例创建时间，格式为yyyy-MM-dd HH:mm:ss。
MaintainStartTime String 04:00:00

运维开始时间，格式为HH:mm:ss。
MaintainEndTime String 05:00:00

运维结束时间，格式为HH:mm:ss。
LockReason String 欠费

锁定原因。
DBInstanceStatus Integer 8

实例状态。
LockMode Integer 0

锁定状态 ：

  • 0：未锁定；
  • 1：锁定。
EngineVersion String 2.0

引擎版本，默认2.0。
DBInstanceStorage Integer 1

存储节点个数。
DBInstanceConnType String lvs

表示用lvs做负载均衡。
DBInstanceId String 304726047

实例ID。
Engine String polarx

引擎， 默认：polarx。
DBInstanceDescription String pxc-sprcym7******

实例描述。
DBInstanceStatusDescription String TDE_MODIFYING

实例状态描述。
Items Array of Items

节点列表。
DBInstanceCreateTime String 2021-10-21T10:30:45Z

实例创建时间。
DBInstanceName String pxc-i-tk6t4z****

实例名称。
CharacterType String 节点角色

节点属性，取值如下：

  • polarx_cn：计算节点；
  • polarx_store：数据节点；
  • polarx_gms：GMS节点。
MaintainStartTime String 不展示

运维开始时间。
DiskSize Long 3145728

磁盘大小。
MaintainEndTime String 不展示

运维结束时间。
LockReason String 不展示

锁定原因。
DBInstanceStatus Integer 8

实例状态。
LockMode Integer 0

是否锁定，取值如下：

  • 0：未锁定；
  • 1：锁定。
EngineVersion String 5.7

引擎版本，默认2.0。
DBInstanceConnType Integer 不展示

连接类型。
MaxConnections Integer 4000

最大连接数。
DBInstanceId String 304726049

实例ID。
Engine String mysql

引擎版本，取值如下：

  • mysql
  • polarx_cdc
  • polarx_dn
MaxIops Integer 7000

最大Iops。
DBInstanceDescription String 不展示

实例描述。
DBInstanceStatusDescription String 不展示

实例状态描述。
ConnectionIp Array of ConnectionIp

数据结构体。
Port String 3306

端口。
DBInstanceNetType Integer 1

内部连接的方式，固定取值为1，表示经典网络。
ConnectionString String pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com

连接信息。
Region String cn-hangzhou

节点所属地域，如果为RDS节点，多个子节点的地域以 ';' 分割。
Azone String cn-hangzhou-a

节点所属可用区，如果为RDS节点，多个子节点的可用区以';'分割。
Role String master

节点角色，取值如下：

  • master：主节点
  • standby：备节点
Activated Boolean true

节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。
AzoneRoleList Array of aoneRoleMap

RDS三节点的数据信息列表。
Azone String cn-hangzhou-a

RDS三节点中某个节点所属可用区。
Role String leader

RDS三节点中某个节点的角色，取值如下：

  • leader：主节点
  • follower：从节点
  • logger：日志节点
Status String 0

节点状态：

  • 0：运行中
  • 1：创建中
  • 2：异常
  • 3：已过期
  • 4：释放中
  • 5：已释放
  • 6：锁定
NodeClass String polarx.x4.large.2e

节点规格：

  • polarx.x4.medium.2e：2核8 GB
  • polarx.x4.large.2e：4核16 GB
  • polarx.x8.large.2e：4核32 GB
  • polarx.x4.xlarge.2e：8核32 GB
  • polarx.x8.xlarge.2e：8核64 GB
  • polarx.x4.2xlarge.2e：16核64 GB
  • polarx.x8.2xlarge.2e：16核128 GB
  • polarx.x4.4xlarge.2e：32核128 GB
  • polarx.x8.4xlarge.2e：32核256 GB
  • polarx.st.8xlarge.2e：60核470 GB
  • polarx.st.12xlarge.2e：90核720 GB
Version String polarx-cdc-kernel-2.0.0-3985896

日志节点版本。
PhyInstanceName String pxc-unrbk8oyz**********

物理实例名
HistoryItems Array of historyItems

历史节点列表。
CharacterType String 节点角色

节点属性，取值如下：

  • polarx_cn：计算节点；
  • polarx_store：数据节点；
  • polarx_gms：GMS节点。
Role String master

节点角色，取值如下：

  • master：主节点
  • standby：备节点
DBInstanceName String pxc-sprcym7g7w****

实例名称。
DBInstanceId String 304726049

实例ID。
Region String cn-hangzhou

节点所属地域，如果为RDS节点，多个子节点的地域以 ';' 分割。
Azone String cn-hangzhou-a

节点所属可用区，如果为RDS节点，多个子节点的可用区以';'分割。
Activated Boolean true

节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。
PhyInstanceName String pxc-unrbk8oyz**********

物理实例名。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBInstanceTopology
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&StartTime=2021-10-21T10:30:45Z 04:00:00
&EndTime=2021-10-22T10:30:45Z 04:00:00
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceTopologyResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <LogicInstanceTopology>
            <DBInstanceName>pxc-sprcym7g7w****</DBInstanceName>
            <DBInstanceCreateTime>2021-10-21T10:30:45Z 04:00:00</DBInstanceCreateTime>
            <MaintainStartTime>04:00:00</MaintainStartTime>
            <MaintainEndTime>05:00:00</MaintainEndTime>
            <LockReason>欠费</LockReason>
            <DBInstanceStatus>8</DBInstanceStatus>
            <LockMode>0</LockMode>
            <EngineVersion>2.0</EngineVersion>
            <DBInstanceStorage>1</DBInstanceStorage>
            <DBInstanceConnType>lvs</DBInstanceConnType>
            <DBInstanceId>304726047</DBInstanceId>
            <Engine>polarx</Engine>
            <DBInstanceDescription>pxc-sprcym7******</DBInstanceDescription>
            <DBInstanceStatusDescription>TDE_MODIFYING</DBInstanceStatusDescription>
            <Items>
                <DBInstanceCreateTime>2021-10-21T10:30:45Z</DBInstanceCreateTime>
                <DBInstanceName>pxc-i-tk6t4z****</DBInstanceName>
                <CharacterType>节点角色</CharacterType>
                <MaintainStartTime>不展示</MaintainStartTime>
                <DiskSize>3145728</DiskSize>
                <MaintainEndTime>不展示</MaintainEndTime>
                <LockReason>不展示</LockReason>
                <DBInstanceStatus>8</DBInstanceStatus>
                <LockMode>0</LockMode>
                <EngineVersion>5.7</EngineVersion>
                <MaxConnections>4000</MaxConnections>
                <DBInstanceId>304726049</DBInstanceId>
                <Engine>mysql</Engine>
                <MaxIops>7000</MaxIops>
                <DBInstanceDescription>不展示</DBInstanceDescription>
                <DBInstanceStatusDescription>不展示</DBInstanceStatusDescription>
                <ConnectionIp>
                    <Port>3306</Port>
                    <DBInstanceNetType>1</DBInstanceNetType>
                    <ConnectionString>pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com</ConnectionString>
                </ConnectionIp>
                <Region>cn-hangzhou</Region>
                <Azone>cn-hangzhou-a</Azone>
                <Role>master</Role>
                <Activated>true</Activated>
                <AzoneRoleList>
                    <Azone>cn-hangzhou-a</Azone>
                    <Role>leader</Role>
                </AzoneRoleList>
                <Status>0</Status>
                <NodeClass>polarx.x4.large.2e</NodeClass>
                <Version>polarx-cdc-kernel-2.0.0-3985896</Version>
                <PhyInstanceName>pxc-unrbk8oyz**********</PhyInstanceName>
            </Items>
            <HistoryItems>
                <CharacterType>节点角色</CharacterType>
                <Role>master</Role>
                <DBInstanceName>pxc-sprcym7g7w****</DBInstanceName>
                <DBInstanceId>304726049</DBInstanceId>
                <Region>cn-hangzhou</Region>
                <Azone>cn-hangzhou-a</Azone>
                <Activated>true</Activated>
                <PhyInstanceName>pxc-unrbk8oyz**********</PhyInstanceName>
            </HistoryItems>
        </LogicInstanceTopology>
    </Data>
</DescribeDBInstanceTopologyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data" : {
    "LogicInstanceTopology" : {
      "DBInstanceName" : "pxc-sprcym7g7w****",
      "DBInstanceCreateTime" : "2021-10-21T10:30:45Z 04:00:00",
      "MaintainStartTime" : "04:00:00",
      "MaintainEndTime" : "05:00:00",
      "LockReason" : "欠费",
      "DBInstanceStatus" : 8,
      "LockMode" : 0,
      "EngineVersion" : "2.0",
      "DBInstanceStorage" : 1,
      "DBInstanceConnType" : "lvs",
      "DBInstanceId" : "304726047",
      "Engine" : "polarx",
      "DBInstanceDescription" : "pxc-sprcym7******",
      "DBInstanceStatusDescription" : "TDE_MODIFYING",
      "Items" : [ {
        "DBInstanceCreateTime" : "2021-10-21T10:30:45Z",
        "DBInstanceName" : "pxc-i-tk6t4z****",
        "CharacterType" : "节点角色",
        "MaintainStartTime" : "不展示",
        "DiskSize" : 3145728,
        "MaintainEndTime" : "不展示",
        "LockReason" : "不展示",
        "DBInstanceStatus" : 8,
        "LockMode" : 0,
        "EngineVersion" : "5.7",
        "MaxConnections" : 4000,
        "DBInstanceId" : "304726049",
        "Engine" : "mysql",
        "MaxIops" : 7000,
        "DBInstanceDescription" : "不展示",
        "DBInstanceStatusDescription" : "不展示",
        "ConnectionIp" : [ {
          "Port" : "3306",
          "DBInstanceNetType" : 1,
          "ConnectionString" : "pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com"
        } ],
        "Region" : "cn-hangzhou",
        "Azone" : "cn-hangzhou-a",
        "Role" : "master",
        "Activated" : true,
        "AzoneRoleList" : [ {
          "Azone" : "cn-hangzhou-a",
          "Role" : "leader"
        } ],
        "Status" : "0",
        "NodeClass" : "polarx.x4.large.2e",
        "Version" : "polarx-cdc-kernel-2.0.0-3985896",
        "PhyInstanceName" : "pxc-unrbk8oyz**********"
      } ],
      "HistoryItems" : [ {
        "CharacterType" : "节点角色",
        "Role" : "master",
        "DBInstanceName" : "pxc-sprcym7g7w****",
        "DBInstanceId" : "304726049",
        "Region" : "cn-hangzhou",
        "Azone" : "cn-hangzhou-a",
        "Activated" : true,
        "PhyInstanceName" : "pxc-unrbk8oyz**********"
      } ]
    }
  }
}

错误码

HttpCode

错误码

错误信息

描述
404 InvalidDBInstance.NotFound The specified DB instance does not exist. 数据库实例不存在

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

上一篇：DescribeDBInstanceConfig下一篇：DescribeDBInstances
文档推荐