擷取邏輯庫與其對應物理分庫的拓撲資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:GetDBTopology |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| LogicDbId |
integer |
是 |
邏輯庫 ID。 說明
您可以通過調用 ListLogicDatabases 介面擷取該參數。 |
134325 |
| Tid |
integer |
否 |
租戶 ID。 說明
取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。 |
43215 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
C5B8E84B-42B6-4374-AD5A-6264E1753378 |
| Success |
boolean |
請求是否成功。 |
true |
| ErrorMessage |
string |
錯誤資訊。 |
UnknownError |
| ErrorCode |
string |
錯誤碼。 |
UnknownError |
| DBTopology |
object |
拓撲資訊 |
|
| LogicDbId |
integer |
邏輯庫 ID。 |
1234 |
| LogicDbName |
string |
邏輯庫名。 |
logic_db_test |
| SearchName |
string |
邏輯庫搜尋名。 |
logic_db_test |
| Alias |
string |
邏輯庫別名。 |
logic_db_test |
| DbType |
string |
資料庫類型，取值請參考 dbType 參數說明。 |
polardb |
| EnvType |
string |
邏輯庫的環境類型，取值和說明如下：
說明
更多資訊，請參見執行個體環境說明。 |
dev |
| DBTopologyInfoList |
array<object> |
分庫拓撲資訊列表。 |
|
|
object |
分庫拓撲資訊。 |
||
| DbId |
integer |
庫 ID |
423532 |
| SchemaName |
string |
庫名。 說明
若資料庫類型是 PG 系列，此處為 PG 模式名。 |
db_test@rm-xxx:3306 |
| CatalogName |
string |
資料庫目錄名。 說明
若資料庫類型為 PG 系列，此處表示 PG 資料庫名。 |
def |
| SearchName |
string |
庫搜尋名。 |
db_test |
| DbType |
string |
資料庫類型，取值請參考 dbType 參數說明。 |
polardb |
| EnvType |
string |
邏輯庫的環境類型，取值和說明如下：
說明
更多資訊，請參見執行個體環境說明。 |
dev |
| InstanceId |
integer |
執行個體 ID。 |
4325325 |
| RegionId |
string |
執行個體所在地區。 |
cn-hangzhou |
| InstanceResourceId |
string |
執行個體資源 ID，取值如下：
|
rm-xxx |
| InstanceSource |
string |
執行個體來源，取值如下：
|
RDS |
樣本
正常返回樣本
JSON格式
{
"RequestId": "C5B8E84B-42B6-4374-AD5A-6264E1753378",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"DBTopology": {
"LogicDbId": 1234,
"LogicDbName": "logic_db_test",
"SearchName": "logic_db_test",
"Alias": "logic_db_test",
"DbType": "polardb",
"EnvType": "dev",
"DBTopologyInfoList": [
{
"DbId": 423532,
"SchemaName": "db_test@rm-xxx:3306",
"CatalogName": "def",
"SearchName": "db_test",
"DbType": "polardb",
"EnvType": "dev",
"InstanceId": 4325325,
"RegionId": "cn-hangzhou",
"InstanceResourceId": "rm-xxx",
"InstanceSource": "RDS"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。