调用GetTableTopology获取数据表的拓扑信息_数据管理(DMS)-阿里云帮助中心

调用GetTableTopology获取数据表的拓扑信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
TableGuid	string	是	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。说明逻辑库：可调用 ListLogicTables 接口获取，需要将 ReturnGuid 参数设置为 true。物理库：可调用 ListTables 接口获取，需要将 ReturnGuid 参数设置为 true。	IDB_L_308302.yuyang_test.test_ch
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F5ED6A40-F344-4C7D-A8F0-5685CA584CA7
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
TableTopology	object	拓扑信息。
TableGuid	string	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。	IDB_L_308302.yuyang_test.test_ch
TableName	string	表名。	test_ch
TableTopologyInfoList	array<object>	表拓扑信息列表。
	object	表拓扑信息。
TableNameList	string	表名列表。说明以逗号隔开。	test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005
TableNameExpr	string	逻辑表的表名表达式。说明物理表则不会显示该参数。	test_ch_[0000-0005]
TableCount	long	表数量。	6
DbId	long	物理库 ID。	43215
DbSearchName	string	库搜索名。说明建议您的业务不要强依赖该参数，后续版本的格式可能会发生变化。	yuyang_test@localhost:3306[yuyang_test_dev]
InstanceId	long	物理库对应的实例 ID。	4325325
RegionId	string	实例 RegionId。	cn-hangzhou
InstanceResourceId	string	实例资源 ID。	rm-xxx
InstanceSource	string	实例来源，取值如下： RDS：阿里云数据库实例 ECS_OWN：阿里云 ECS 自建库实例 PUBLIC_OWN：公网自建库实例 VPC_ID：VPC 专线 IDC 数据库实例 GATEWAY：数据库网关实例	RDS
DbName	string	库名。	yuyang_test
DbType	string	数据库类型。	mysql
Logic	boolean	是否为逻辑表，取值： true：是 false：否	true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史