调用GetTableTopology获取数据表的拓扑信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
TableGuid String IDB_L_308302.yuyang_test.test_ch

表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

说明
  • 逻辑库:可调用ListLogicTables接口获取,需要将ReturnGuid参数设置为true。
  • 物理库:可条用ListTables接口获取,需要将ReturnGuid参数设置为true。
Tid Long 1

租户ID。

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String F5ED6A40-F344-4C7D-A8F0-5685CA584CA7

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

TableTopology object

拓扑信息。

TableGuid String IDB_L_308302.yuyang_test.test_ch

表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

TableName String test_ch

表名。

TableTopologyInfoList Array of TableTopologyInfo

表拓扑信息列表。

TableNameList String test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005

表名列表。

说明 以逗号隔开。
TableNameExpr String test_ch_[0000-0005]

逻辑表的表名表达式。

说明 物理表则不会显示该参数。
TableCount Long 6

表数量。

DbId Long 43215

物理库ID。

DbSearchName String yuyang_test@localhost:3306【yuyang_test_dev】

库搜索名。

InstanceId Long 4325325

物理库对应的实例ID。

RegionId String cn-hangzhou

实例RegionId。

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:数据库网关实例
DbName String yuyang_test

库名。

DbType String mysql

数据库类型。

Logic Boolean true

是否为逻辑表,取值:

  • true:是
  • false:否

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?TableGuid=IDB_L_308302.yuyang_test.test_ch
&Tid=1
&公共请求参数

正常返回示例

XML格式

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

<GetTableTopologyResponse>
    <RequestId>7A7F0E34-8E21-4CF7-93C8-27212B122145</RequestId>
    <TableTopology>
        <TableName>big_table</TableName>
        <TableGuid>IDB_279000000.film.big_table</TableGuid>
        <Logic>false</Logic>
        <TableTopologyInfoList>
            <DbSearchName>film@rm-uf00000000240000l.mysql.rds.aliyuncs.com:3306【nissi go】</DbSearchName>
            <InstanceSource>RDS</InstanceSource>
            <InstanceResourceId>rm-uf00000000240000l</InstanceResourceId>
            <InstanceId>1000000</InstanceId>
            <TableNameList>big_table</TableNameList>
            <TableCount>1</TableCount>
            <DbId>4000000</DbId>
            <DbName>film</DbName>
            <RegionId>cn-shanghai</RegionId>
            <DbType>mysql</DbType>
        </TableTopologyInfoList>
    </TableTopology>
    <Success>true</Success>    
</GetTableTopologyResponse>

JSON格式

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

{
  "RequestId" : "7A7F0E34-8E21-4CF7-93C8-27212B122145",
  "TableTopology" : {
    "TableName" : "big_table",
    "TableGuid" : "IDB_279000000.film.big_table",
    "Logic" : false,
    "TableTopologyInfoList" : [ {
      "DbSearchName" : "film@rm-uf00000000240000l.mysql.rds.aliyuncs.com:3306【nissi go】",
      "InstanceSource" : "RDS",
      "InstanceResourceId" : "rm-uf00000000240000l",
      "InstanceId" : 1000000,
      "TableNameList" : "big_table",
      "TableCount" : 1,
      "DbId" : 4000000,
      "DbName" : "film",
      "RegionId" : "cn-shanghai",
      "DbType" : "mysql"
    } ]
  },
  "Success" : true
}

错误码

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