GetTableDBTopology - query data table database topology in DMS - Data Management

Queries the topology of a data table.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetTableDBTopology

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. Manage DMS tenants.	3***
TableGuid	string	Yes	The GUID of the table in DMS. Note For logical databases, call ListLogicTables with ReturnGuid set to true. For physical databases, call ListTables with ReturnGuid set to true.	IDB_L_9032.db-test.yuyang_test

Response elements

Element	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.
	array<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 database type. Valid values: DbType parameter.	MySQL
DatabaseList	array<object>	The physical databases.
	array<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 database type. Valid values: DbType parameter.	MySQL
TableList	array<object>	The physical tables.
	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 environment type of the database. 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 Change the environment type of an instance.	pre
Port	integer	The connection port of 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	Whether the request was successful.	true

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.