GetTableDBTopology - 数据管理 DMS

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Tid	Long	否	1	租户ID。说明取自系统右上角头像处悬停展示的租户ID信息，详情请参见查看租户信息。
TableGuid	String	是	IDB_L_9032.db-test.yuyang_test	表在DMS中的唯一识别码GUID（Globally Unique Identifier）。说明逻辑库：可调用ListLogicTables接口获取，需要将ReturnGuid参数设置为true。物理库：可条用ListTables接口获取，需要将ReturnGuid参数设置为true。
RegionId	String	否	cn-hangzhou	选择DMS的服务地域，用于调用该接口，取值请参见RegionID参数说明。说明请根据应用所在地就近选择。

返回数据


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

示例

请求示例

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

正常返回示例

XML格式

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

<GetTableDBTopologyResponse>
    <RequestId>78F78156-2BBE-414A-8A9D-BE61CF6FA60F</RequestId>
    <DBTopology>
        <TableName>big_table</TableName>
        <TableGuid>IDB_270000001.film.big_table</TableGuid>
        <DataSourceList>
            <DatabaseList>
                <DbId>4000000</DbId>
                <DbName>film</DbName>
                <TableList>
                    <TableId>200000000</TableId>
                    <TableName>big_table</TableName>
                    <TableType>NORMAL</TableType>
                </TableList>
                <EnvType>product</EnvType>
                <DbType>mysql</DbType>
            </DatabaseList>
            <Port>3306</Port>
            <Host>rm-uf000000z0000002l.mysql.rds.aliyuncs.com</Host>
            <DbType>mysql</DbType>
        </DataSourceList>
    </DBTopology>
    <Success>true</Success>    
</GetTableDBTopologyResponse>

JSON格式

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

{
  "RequestId" : "78F78156-2BBE-414A-8A9D-BE61CF6FA60F",
  "DBTopology" : {
    "TableName" : "big_table",
    "TableGuid" : "IDB_270000001.film.big_table",
    "DataSourceList" : [ {
      "DatabaseList" : [ {
        "DbId" : 4000000,
        "DbName" : "film",
        "TableList" : [ {
          "TableId" : 200000000,
          "TableName" : "big_table",
          "TableType" : "NORMAL"
        } ],
        "EnvType" : "product",
        "DbType" : "mysql"
      } ],
      "Port" : 3306,
      "Host" : "rm-uf000000z0000002l.mysql.rds.aliyuncs.com",
      "DbType" : "mysql"
    } ]
  },
  "Success" : true
}

错误码

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