The call GetTableTopology obtains the topology information 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
TableGuid String Yes IDB_L_308302.yuyang_test.test_ch

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.
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 .
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 F5ED6A40-F344-4C7D-A8F0-5685CA584CA7

The request ID.

Success Boolean true

Whether the request is successful.

ErrorMessage String UnknownError

Error message.

ErrorCode String UnknownError

Error code.

TableTopology object

The topology information.

TableGuid String IDB_L_308302.yuyang_test.test_ch

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

TableName String test_ch

Table name.

TableTopologyInfoList Array of TableTopologyInfo

The list of table topology information.

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

The list of table names.

Note Separated by commas.
TableNameExpr String test_ch_[0000-0005]

The table name expression of the logical table.

Note This parameter is not displayed in the physical table.
TableCount Long 6

The number of tables.

DbId Long 43215

The physical library ID.

DbSearchName String yuyang_test@localhost:3306

The library search name.

InstanceId Long 4325325

The instance ID corresponding to the physical library.

RegionId String cn-hangzhou

Instance RegionId.

InstanceResourceId String rm-xxx

The instance resource ID. The value is as follows:

  • RDS : Alibaba Cloud database instance ID
  • ECS_OWN : ECS instance ID
  • PUBLIC_OWN : empty
  • VPC_ID :VPC ID
  • GATEWAY : The database gateway instance ID
InstanceSource String RDS

The source of the instance. The value is as follows:

  • RDS : an Alibaba Cloud database instance
  • ECS_OWN : ECS a self-built library instance
  • PUBLIC_OWN : Public network self-built database instance
  • VPC_ID : VPC leased line IDC database instance
  • GATEWAY : The database gateway instance
DbName String yuyang_test

The name of the library.

DbType String mysql

The database type.

Logic Boolean true

Whether it is a logical table. Valid values:

  • true : Yes
  • false : No

Examples

Sample requests


     http(s)://dms-enterprise.aliyuncs.com/? TableGuid=IDB_L_308302.yuyang_test.test_ch &Tid=1&Public request parameters 
   

Sample success responses

XML Format


     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</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 Format


     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", "InstanceSource" : "RDS", "InstanceResourceId" : "rm-uf00000000240000l", "InstanceId" : 1000000, "TableNameList" : "big_table", "TableCount" : 1, "DbId" : 4000000, "DbName" : "film", "RegionId" : "cn-shanghai", "DbType" : "mysql" } ] }, "Success" : true} 
   

Error code

Access Error Center See more error codes.