全部产品
Search

搜索本产品

    数据管理 DMS：GetTableTopology - 获取数据表的拓扑信息

    文档中心

    数据管理 DMS：GetTableTopology - 获取数据表的拓扑信息

    更新时间：Aug 27, 2026

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:GetTableTopology

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    TableGuid

    string

    是

    表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。

    说明

    • 逻辑库：可调用 ListLogicTables 接口获取，需要将 ReturnGuid 参数设置为 true。

    • 物理库：可调用 ListTables 接口获取，需要将 ReturnGuid 参数设置为 true。

    IDB_L_308302.yuyang_test.test_ch
    Tid

    integer

    否

    租户 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

    integer

    表数量。

    6
    DbId

    integer

    物理库 ID。

    43215
    DbSearchName

    string

    库搜索名。

    说明

    建议您的业务不要强依赖该参数，后续版本的格式可能会发生变化。

    yuyang_test@localhost:3306[yuyang_test_dev]
    InstanceId

    integer

    物理库对应的实例 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
  }
}

    错误码

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

    变更历史

    更多信息，参考变更详情。