调用GetDBInstanceTopology查看RDS实例的拓扑结构。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetDBInstanceTopology

系统规定参数。取值：GetDBInstanceTopology。

DBInstanceId String 是 rm-uf6wjk5*******

实例ID。可调用DescribeDBInstances获取。

返回数据

名称 类型 示例值 描述
Code String None

内部参数，无需关注。
Message String None

内部参数，无需关注。
RequestId String 7430AB1A-6D49-5B6D-B9E5-920250076074

请求ID。
Data Object

拓扑结构详情。
DBInstanceName String rm-m5ezban**********

实例ID。
Connections Array of Connection

实例的网络连接信息。
ZoneId String cn-qingdao-c

可用区ID。
DBInstanceName String rm-m5ezban**********

实例ID。
ConnectionString String rm-m5ezban**********.mysql.rds.aliyuncs.com

数据库连接地址。
NetType String vpc

实例的网络连接地址类型。取值：

  • vpc：内网连接地址。
  • public：公网连接地址。
Nodes Array of Node

节点信息。
DBInstanceName String rm-m5ezban**********

实例ID。
ZoneId String cn-qingdao-c

可用区ID。
DedicatedHostId String i-bpxxxxxxx

专属集群内的主机ID。

说明 非专属集群实例返回空。
Role String master

节点类型。返回值：

  • Master：主节点。
  • Slave：备节点。
NodeId String 349054

实例的唯一标识。

说明 非专属集群实例返回-1。
DedicatedHostGroupId String dhg-4n*****

专属集群ID。

说明 非专属集群实例返回空。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=GetDBInstanceTopology
&DBInstanceId=rm-uf6wjk5*******
&公共请求参数

正常返回示例

XML格式 

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

<GetDBInstanceTopologyResponse>
    <RequestId>CF5A551A-80EF-1D3D-8F43-6B52C1E2EF71</RequestId>
    <Data>
    </Data>
</GetDBInstanceTopologyResponse>

JSON格式 

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

{
  "RequestId" : "CF5A551A-80EF-1D3D-8F43-6B52C1E2EF71",
  "Data" : {
    "Connections" : [ ],
    "Nodes" : [ ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidAction Specified action is not valid. 不支持当前操作。
403 DBInstanceStatusNotActive The status of the current instance is not active. 操作失败，请检查实例运行状态。
403 DBTypeNotSupported The database type is not supported. 不支持数据库类型
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. 没有找到指定的实例，请检查实例的正确性。

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