全部產品
Search

搜尋本產品

    Data Management：GetTableTopology - 擷取資料表的拓撲資訊

    文件中心

    Data Management：GetTableTopology - 擷取資料表的拓撲資訊

    更新時間：Mar 21, 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
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。