GetTableDBTopology - 获取逻辑表的拓扑图 - 数据管理 DMS

获取数据表的拓扑图。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetTableDBTopology	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
TableGuid	string	是	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。说明逻辑库：可调用 ListLogicTables 接口获取，需要将 ReturnGuid 参数设置为 true。物理库：可调用 ListTables 接口获取，需要将 ReturnGuid 参数设置为 true。	IDB_L_9032.db-test.yuyang_test

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	853F7FD4-D922-4EFB-931C-D253EF159E06
DBTopology	object	DB 拓扑信息。
TableName	string	表名。说明如果查询逻辑表，将返回逻辑表表名。如果查询物理表，将返回物理表表名。	yuyang_test
DataSourceList	array<object>	数据源列表。
DataSource	object	Schema of Response
Sid	string	数据源 SID。	def
Host	string	数据源的连接地址。	xxx.mysql.polardb.rds.aliyuncs.com
DbType	string	数据库类型，取值请参考 dbType 参数说明。	MySQL
DatabaseList	array<object>	物理分库列表。
Database	object	Schema of Response
DbId	string	库 ID。	489347
DbName	string	物理库库名。	db-test
DbType	string	数据库类型，取值请参考 dbType 参数说明。	MySQL
TableList	array<object>	物理分表列表。
Table	object	Schema of Response
TableName	string	物理表表名。	151977812
TableType	string	表类型，保留字段。	yuyang_test_0000
TableId	string	表 ID。	NORMAL
EnvType	string	环境类型，取值和说明如下： product：生产环境 dev：开发环境 pre：预发环境 test：测试环境 sit：SIT 环境 uat：UAT 环境 pet：压测环境 stag：STAG 环境说明更多信息，请参见实例环境说明。	pre
Port	integer	数据源连接端口。	3306
TableGuid	string	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。	IDB_L_9032.db-test.yuyang_test
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "853F7FD4-D922-4EFB-931C-D253EF159E06",
  "DBTopology": {
    "TableName": "yuyang_test",
    "DataSourceList": [
      {
        "Sid": "def",
        "Host": "xxx.mysql.polardb.rds.aliyuncs.com",
        "DbType": "MySQL",
        "DatabaseList": [
          {
            "DbId": "489347",
            "DbName": "db-test",
            "DbType": "MySQL",
            "TableList": [
              {
                "TableName": "151977812",
                "TableType": "yuyang_test_0000",
                "TableId": "NORMAL"
              }
            ],
            "EnvType": "pre"
          }
        ],
        "Port": 3306
      }
    ],
    "TableGuid": "IDB_L_9032.db-test.yuyang_test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

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

暂无变更历史