Call the GetTableDBTopology interface to obtain the topology diagram of the data table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Parameters

Parameter Type Required Example Description
Tid Long No 1

The tenant ID.

Note Take the tenant ID information displayed in the upper right corner of the system. For details, see View tenant information .
TableGuid String Yes IDB_L_9032.db-test.yuyang_test

The unique identifier GUID(Globally Unique Identifier) of the table in DMS.

Note
  • Logical Library: callable ListLogicTables Interface acquisition, you need to set the ReturnGuid parameter to true.
  • Physical Library: Available ListTables Interface acquisition, you need to set the ReturnGuid parameter to true.
RegionId String No cn-hangzhou

Select the service region of DMS to call the interface. For the value, see RegionID parameter description .

Note Please select nearby according to the application location.

Return data

Parameter Type Example Description
RequestId String 853F7FD4-D922-4EFB-931C-D253EF159E06

The request ID.
DBTopology object

The DB topology information.
TableName String yuyang_test

Table name.

Note
  • If you query a logical table, the logical table table name is returned.
  • If you query a physical table, the physical table table name is returned.
DataSourceList Array of DataSource

The list of data sources.
Sid String def

The data source SID.
Host String xxx.mysql.polardb.rds.aliyuncs.com

The connection address of the data source.
DbType String MySQL

Database type, please refer to the value. DbType parameter description .

DatabaseList Array of Database

The list of physical shards.
DbId String 489347

The Library ID.
DbName String db-test

Physical Library name.
DbType String MySQL

Database type, please refer to the value. DbType parameter description .

TableList Array of Table

The list of physical table shards.
TableName String 151977812

Table ID.
TableType String yuyang_test_0000

The physical table name.
TableId String NORMAL

Table type, Reserved fields.
EnvType String pre

The environment type, value and description are as follows:

  • product : production environment
  • dev : development environment
  • pre : staging environment
  • test : test environment
  • sit : SIT environment
  • uat : UAT environment
  • pet : Pressure measurement environment
  • stag : STAG environment
Note For more information, see Instance environment description .
Port Integer 3306

The data source connection port.
TableGuid String IDB_L_9032.db-test.yuyang_test

The unique identifier GUID(Globally Unique Identifier) of the table in DMS.
ErrorCode String UnknownError

Error code.
ErrorMessage String UnknownError

Error message.
Success Boolean true

Whether the request is successful.

Examples

Sample requests


     http(s)://dms-enterprise.aliyuncs.com/? Tid=1 &TableGuid=IDB_L_9032.db-test.yuyang_test&public request parameters

Sample success responses

XML Format 


     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 Format 


     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 }

Error code

Access Error Center See more error codes.