GetTableDBTopology - Data Management - Alibaba Cloud Documentation Center

Queries the topology of a data table.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetTableDBTopology	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	3***
TableGuid	string	Yes	The GUID of the table in DMS. Note If the database to which the table belongs is a logical database, you can call the ListLogicTables operation to obtain the GUID. The value of the ReturnGuid parameter must be set to true. If the database to which the table belongs is a physical database, you can call the ListTables operation to obtain the GUID. The value of the ReturnGuid parameter must be set to true.	IDB_L_9032.db-test.yuyang_test

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	853F7FD4-D922-4EFB-931C-D253EF159E06
DBTopology	object	The topology of the data table.
TableName	string	The name of the table. Note If a logical table is queried, the name of the logical table is returned. If a physical table is queried, the name of the physical table is returned.	yuyang_test
DataSourceList	array<object>	The data sources.
DataSource	object	The schema of the response.
Sid	string	The system ID (SID) of the data source.	def
Host	string	The endpoint of the data source.	xxx.mysql.polardb.rds.aliyuncs.com
DbType	string	The type of the database. For more information about the valid values of this parameter, see DbType parameter.	MySQL
DatabaseList	array<object>	The physical databases.
Database	object	The schema of the response.
DbId	string	The ID of the database.	489347
DbName	string	The name of the database.	db-test
DbType	string	The type of the database. For more information about the valid values of this parameter, see DbType parameter.	MySQL
TableList	array<object>	The physical tables.
Table	object	The schema of the response.
TableName	string	The name of the physical table.	151977812
TableType	string	The type of the table. This is a reserved parameter.	yuyang_test_0000
TableId	string	The ID of the table.	NORMAL
EnvType	string	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: pre-release environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: staging environment Note For more information, see Change the environment type of an instance.	pre
Port	integer	The port that is used to connect to the data source.	3306
TableGuid	string	The GUID of the table in DMS.	IDB_L_9032.db-test.yuyang_test
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history