GetTableTopology - Query table topology in DMS - Data Management

Queries the topology of a 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:GetTableTopology

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TableGuid	string	Yes	The GUID of the table in DMS. Note Call ListLogicTables with ReturnGuid set to true to query logical table GUIDs in a logical database. Call ListTables with ReturnGuid set to true to query table GUIDs in a physical database.	IDB_L_308302.yuyang_test.test_ch
Tid	integer	No	The tenant ID. Note To find the tenant ID, hover over your profile picture in the upper-right corner of the DMS console, as described in Tenant information.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	F5ED6A40-F344-4C7D-A8F0-5685CA584CA7
Success	boolean	Indicates whether the request is successful.	true
ErrorMessage	string	The error message.	UnknownError
ErrorCode	string	The error code.	UnknownError
TableTopology	object	The topology information.
TableGuid	string	The GUID of the table in DMS.	IDB_L_308302.yuyang_test.test_ch
TableName	string	The table name.	test_ch
TableTopologyInfoList	array<object>	The topology details of the table.
	object	The topology details of the table.
TableNameList	string	The table names. Note The table names are separated by commas (,).	test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005
TableNameExpr	string	The expression for logical table names. Description This parameter is not returned for physical tables.	test_ch_[0000-0005]
TableCount	integer	The number of tables.	6
DbId	integer	The physical database ID.	43215
DbSearchName	string	The search name of the database. Note Do not use this parameter in business logic. The value format may change in later versions.	yuyang_test@localhost:3306[yuyang_test_dev]
InstanceId	integer	The instance ID of the physical database.	4325325
RegionId	string	The region ID of the instance.	cn-hangzhou
InstanceResourceId	string	The resource ID of the instance. The value depends on the instance type specified by InstanceSource. RDS: The ApsaraDB RDS instance ID. ECS_OWN: The ECS instance ID. PUBLIC_OWN: Left empty for self-managed databases connected over the Internet. VPC_ID: The VPC ID. GATEWAY: The database gateway ID.	rm-xxx
InstanceSource	string	The type of the database instance. Valid values: RDS: an ApsaraDB RDS instance. ECS_OWN: a self-managed database deployed on an ECS instance. PUBLIC_OWN: a self-managed database connected over the Internet. VPC_ID: a self-managed database in a VPC connected over Express Connect circuits. GATEWAY: a database instance connected through a database gateway.	RDS
DbName	string	The database name.	yuyang_test
DbType	string	The database engine.	mysql
Logic	boolean	Indicates whether the table is a logical table. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "F5ED6A40-F344-4C7D-A8F0-5685CA584CA7",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TableTopology": {
    "TableGuid": "IDB_L_308302.yuyang_test.test_ch",
    "TableName": "test_ch",
    "TableTopologyInfoList": [
      {
        "TableNameList": "test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005",
        "TableNameExpr": "test_ch_[0000-0005]",
        "TableCount": 6,
        "DbId": 43215,
        "DbSearchName": "yuyang_test@localhost:3306[yuyang_test_dev]",
        "InstanceId": 4325325,
        "RegionId": "cn-hangzhou",
        "InstanceResourceId": "rm-xxx",
        "InstanceSource": "RDS",
        "DbName": "yuyang_test",
        "DbType": "mysql"
      }
    ],
    "Logic": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.