使用GetTableDBTopology擷取資料表的拓撲圖-Data Management-阿里雲

擷取資料表的拓撲圖。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetTableDBTopology

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	3***
TableGuid	string	是	表在 DMS 中的唯一識別碼 GUID（Globally Unique Identifier）。說明邏輯庫：可調用 ListLogicTables 介面擷取，需要將 ReturnGuid 參數設定為 true。物理庫：可調用 ListTables 介面擷取，需要將 ReturnGuid 參數設定為 true。	IDB_L_9032.db-test.yuyang_test

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	853F7FD4-D922-4EFB-931C-D253EF159E06
DBTopology	object	DB 拓撲資訊。
TableName	string	表名。說明如果查詢邏輯表，將返回邏輯表表名。如果查詢物理表，將返回物理表表名。	yuyang_test
DataSourceList	array<object>	資料來源列表。
	array<object>	Schema of Response
Sid	string	資料來源 SID。	def
Host	string	資料來源的串連地址。	xxx.mysql.polardb.rds.aliyuncs.com
DbType	string	資料庫類型，取值請參考 dbType 參數說明。	MySQL
DatabaseList	array<object>	物理分庫列表。
	array<object>	Schema of Response
DbId	string	庫 ID。	489347
DbName	string	物理庫庫名。	db-test
DbType	string	資料庫類型，取值請參考 dbType 參數說明。	MySQL
TableList	array<object>	物理分表列表。
	object	Schema of Response
TableName	string	物理表表名。	151977812
TableType	string	表類型，保留欄位。	yuyang_test_0000
TableId	string	表 ID。	NORMAL
EnvType	string	環境類型，取值和說明如下： product：生產環境 dev：開發環境 pre：預發環境 test：測試環境 sit：SIT 環境 uat：UAT 環境 pet：壓測環境 stag：STAG 環境說明更多資訊，請參見執行個體環境說明。	pre
Port	integer	資料來源串連連接埠。	3306
TableGuid	string	表在 DMS 中的唯一識別碼 GUID（Globally Unique Identifier）。	IDB_L_9032.db-test.yuyang_test
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "853F7FD4-D922-4EFB-931C-D253EF159E06",
  "DBTopology": {
    "TableName": "yuyang_test",
    "DataSourceList": [
      {
        "Sid": "def",
        "Host": "xxx.mysql.polardb.rds.aliyuncs.com",
        "DbType": "MySQL",
        "DatabaseList": [
          {
            "DbId": "489347",
            "DbName": "db-test",
            "DbType": "MySQL",
            "TableList": [
              {
                "TableName": "151977812",
                "TableType": "yuyang_test_0000",
                "TableId": "NORMAL"
              }
            ],
            "EnvType": "pre"
          }
        ],
        "Port": 3306
      }
    ],
    "TableGuid": "IDB_L_9032.db-test.yuyang_test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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