首页 数据管理 DMS API参考 API目录 库表元数据 逻辑库表 GetDBTopology - 获取逻辑库拓扑信息

GetDBTopology - 获取逻辑库拓扑信息

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetDBTopologyRead
  • DMSEnterprise
    *

请求参数

名称类型必填描述示例值
LogicDbIdlong

逻辑库ID。

说明您可以通过调用ListLogicDatabases接口获取该参数。
134325
Tidlong

租户ID。

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

C5B8E84B-42B6-4374-AD5A-6264E1753378
Successboolean

请求是否成功。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
DBTopologyobject

拓扑信息

LogicDbIdlong

逻辑库ID。

1234
LogicDbNamestring

逻辑库名。

logic_db_test
SearchNamestring

逻辑库搜索名。

logic_db_test
Aliasstring

逻辑库别名。

logic_db_test
DbTypestring

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

polardb
EnvTypestring

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

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

分库拓扑信息列表。

DbIdlong

库ID

423532
SchemaNamestring

库名。

说明若数据库类型是PG系列,此处为PG模式名。
db_test@rm-xxx:3306
CatalogNamestring

数据库目录名。

说明若数据库类型为PG系列,此处表示PG数据库名。
def
SearchNamestring

库搜索名。

db_test
DbTypestring

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

polardb
EnvTypestring

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

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

实例ID。

4325325
RegionIdstring

实例所在地域。

cn-hangzhou
InstanceResourceIdstring

实例资源ID,取值如下:

  • RDS:阿里云数据库实例ID
  • ECS_OWN:阿里云ECS实例ID
  • PUBLIC_OWN:空
  • VPC_ID:VPC ID
  • GATEWAY:数据库网关实例ID
rm-xxx
InstanceSourcestring

实例来源,取值如下:

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

示例

正常返回示例

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

错误码

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

阿里云首页 数据管理 相关技术圈