调用GetDBTopology获取逻辑库拓扑信息_数据管理(DMS)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
LogicDbId	long	是	逻辑库 ID。说明您可以通过调用 ListLogicDatabases 接口获取该参数。	134325
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	43215

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	C5B8E84B-42B6-4374-AD5A-6264E1753378
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
DBTopology	object	拓扑信息
LogicDbId	long	逻辑库 ID。	1234
LogicDbName	string	逻辑库名。	logic_db_test
SearchName	string	逻辑库搜索名。	logic_db_test
Alias	string	逻辑库别名。	logic_db_test
DbType	string	数据库类型，取值请参考 dbType 参数说明。	polardb
EnvType	string	逻辑库的环境类型，取值和说明如下： product：生产环境 dev：开发环境 pre：预发环境 test：测试环境 sit：SIT 环境 uat：UAT 环境 pet：压测环境 stag：STAG 环境说明更多信息，请参见实例环境说明。	dev
DBTopologyInfoList	array<object>	分库拓扑信息列表。
	object	分库拓扑信息。
DbId	long	库 ID	423532
SchemaName	string	库名。说明若数据库类型是 PG 系列，此处为 PG 模式名。	db_test@rm-xxx:3306
CatalogName	string	数据库目录名。说明若数据库类型为 PG 系列，此处表示 PG 数据库名。	def
SearchName	string	库搜索名。	db_test
DbType	string	数据库类型，取值请参考 dbType 参数说明。	polardb
EnvType	string	逻辑库的环境类型，取值和说明如下： product：生产环境 dev：开发环境 pre：预发环境 test：测试环境 sit：SIT 环境 uat：UAT 环境 pet：压测环境 stag：STAG 环境说明更多信息，请参见实例环境说明。	dev
InstanceId	long	实例 ID。	4325325
RegionId	string	实例所在地域。	cn-hangzhou
InstanceResourceId	string	实例资源 ID，取值如下： RDS：阿里云数据库实例 ID ECS_OWN：阿里云 ECS 实例 ID PUBLIC_OWN：空 VPC_ID：VPC ID GATEWAY：数据库网关实例 ID	rm-xxx
InstanceSource	string	实例来源，取值如下： 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"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史