调用GetDBTopology获取逻辑库与其对应物理分库的拓扑信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
LogicDbId Long 134325

逻辑库ID。

说明 您可以通过调用ListLogicDatabases接口获取该参数。
Tid Long 43215

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String C5B8E84B-42B6-4374-AD5A-6264E1753378

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

DBTopology object

拓扑信息

LogicDbId Long 1234

逻辑库ID。

LogicDbName String logic_db_test

逻辑库名。

SearchName String logic_db_test

逻辑库搜索名。

Alias String logic_db_test

逻辑库别名。

DbType String polardb

数据库类型,取值请参考dbType参数说明

EnvType String dev

逻辑库的环境类型,取值和说明如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
说明 更多信息,请参见实例环境说明
DBTopologyInfoList Array of DBTopologyInfo

分库拓扑信息列表。

DbId Long 423532

库ID

SchemaName String db_test@rm-xxx:3306

库名。

说明 若数据库类型是PG系列,此处为PG模式名。
CatalogName String def

数据库目录名。

说明 若数据库类型为PG系列,此处表示PG数据库名。
SearchName String db_test

库搜索名。

DbType String polardb

数据库类型,取值请参考dbType参数说明

EnvType String dev

逻辑库的环境类型,取值和说明如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
说明 更多信息,请参见实例环境说明
InstanceId Long 4325325

实例ID。

RegionId String cn-hangzhou

实例所在地域。

InstanceResourceId String rm-xxx

实例资源ID,取值如下:

  • RDS:阿里云数据库实例ID
  • ECS_OWN:阿里云ECS实例ID
  • PUBLIC_OWN:空
  • VPC_ID:VPC ID
  • GATEWAY:数据库网关实例ID
InstanceSource String RDS

实例来源,取值如下:

  • RDS:阿里云数据库实例
  • ECS_OWN:阿里云ECS自建库实例
  • PUBLIC_OWN:公网自建库实例
  • VPC_ID:VPC专线IDC数据库实例
  • GATEWAY:数据库网关实例

示例

请求示例

http(s)://[Endpoint]/?LogicDbId=134325
&Tid=43215
&公共请求参数

正常返回示例

XML格式

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

<RequestId>C5B8E84B-42B6-4374-AD5A-6264E1753378</RequestId>
<Success>true</Success>
<ErrorMessage>UnknownError</ErrorMessage>
<ErrorCode>UnknownError</ErrorCode>
<DBTopology>
    <LogicDbId>1234</LogicDbId>
    <LogicDbName>logic_db_test</LogicDbName>
    <SearchName>logic_db_test</SearchName>
    <Alias>logic_db_test</Alias>
    <DbType>polardb</DbType>
    <EnvType>dev</EnvType>
    <DBTopologyInfoList>
        <DbId>423532</DbId>
        <SchemaName>db_test@rm-xxx:3306</SchemaName>
        <CatalogName>def</CatalogName>
        <SearchName>db_test</SearchName>
        <DbType>polardb</DbType>
        <EnvType>dev</EnvType>
        <InstanceId>4325325</InstanceId>
        <RegionId>cn-hangzhou</RegionId>
        <InstanceResourceId>rm-xxx</InstanceResourceId>
        <InstanceSource>RDS</InstanceSource>
    </DBTopologyInfoList>
</DBTopology>

JSON格式

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

{
  "RequestId" : "C5B8E84B-42B6-4374-AD5A-6264E1753378",
  "Success" : true,
  "ErrorMessage" : "UnknownError",
  "ErrorCode" : "UnknownError",
  "DBTopology" : {
    "LogicDbId" : 1234,
    "LogicDbName" : "logic_db_test",
    "SearchName" : "logic_db_test",
    "Alias" : "logic_db_test",
    "DbType" : "polardb",
    "EnvType" : "dev",
    "DBTopologyInfoList" : [ {
      "DbId" : 423532,
      "SchemaName" : "db_test@rm-xxx:3306",
      "CatalogName" : "def",
      "SearchName" : "db_test",
      "DbType" : "polardb",
      "EnvType" : "dev",
      "InstanceId" : 4325325,
      "RegionId" : "cn-hangzhou",
      "InstanceResourceId" : "rm-xxx",
      "InstanceSource" : "RDS"
    } ]
  }
}

错误码

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