首页 数据管理 DMS API参考 API目录 库表元数据 GetTableTopology - 获取数据表的拓扑信息

GetTableTopology - 获取数据表的拓扑信息

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetTableTopologyRead
    全部资源

请求参数

名称类型必填描述示例值
TableGuidstring

表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

说明
  • 逻辑库:可调用ListLogicTables接口获取,需要将ReturnGuid参数设置为true。
  • 物理库:可调用ListTables接口获取,需要将ReturnGuid参数设置为true。
  • IDB_L_308302.yuyang_test.test_ch
    Tidlong

    租户ID。

    说明取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
    3***

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求ID。

    F5ED6A40-F344-4C7D-A8F0-5685CA584CA7
    Successboolean

    请求是否成功。

    true
    ErrorMessagestring

    错误信息。

    UnknownError
    ErrorCodestring

    错误码。

    UnknownError
    TableTopologyobject

    拓扑信息。

    TableGuidstring

    表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

    IDB_L_308302.yuyang_test.test_ch
    TableNamestring

    表名。

    test_ch
    TableTopologyInfoListarray

    表拓扑信息列表。

    object

    表拓扑信息。

    TableNameListstring

    表名列表。

    说明以逗号隔开。
    test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005
    TableNameExprstring

    逻辑表的表名表达式。

    说明物理表则不会显示该参数。
    test_ch_[0000-0005]
    TableCountlong

    表数量。

    6
    DbIdlong

    物理库ID。

    43215
    DbSearchNamestring

    库搜索名。

    yuyang_test@localhost:3306【yuyang_test_dev】
    InstanceIdlong

    物理库对应的实例ID。

    4325325
    RegionIdstring

    实例RegionId。

    cn-hangzhou
    InstanceResourceIdstring

    实例资源ID,取值如下:

    • RDS:阿里云数据库实例ID
    • ECS_OWN:阿里云ECS实例ID
    • PUBLIC_OWN:空
    • VPC_ID:VPC ID
    • GATEWAY:数据库网关实例ID
    rm-xxx
    InstanceSourcestring

    实例来源,取值如下:

    • RDS:阿里云数据库实例
    • ECS_OWN:阿里云ECS自建库实例
    • PUBLIC_OWN:公网自建库实例
    • VPC_ID:VPC专线IDC数据库实例
    • GATEWAY:数据库网关实例
    RDS
    DbNamestring

    库名。

    yuyang_test
    DbTypestring

    数据库类型。

    mysql
    Logicboolean

    是否为逻辑表,取值:

    • 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
      }
    }

    错误码

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

    阿里云首页 数据管理 相关技术圈