使用GetLogicDatabase API擷取邏輯庫資訊-Data Management-阿里雲

擷取邏輯庫詳情資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetLogicDatabase

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明滑鼠移動到介面右上方的頭像處，查看租戶 ID。具體操作，請參見查看租戶資訊。	3***
DbId	string	是	邏輯庫 ID（DatabaseId），可通過調用介面 ListLogicDatabases 或 SearchDatabase 擷取該參數的值。	1***

返回參數

名稱	類型	描述	樣本值
	object
LogicDatabase	object	邏輯庫詳情資訊。
DatabaseId	string	邏輯庫 ID。	1***
OwnerIdList	object
OwnerIds	array	邏輯庫 Owner 的使用者識別碼列表。
	string	邏輯庫 Owner 的使用者識別碼。	51****
DbType	string	資料庫類型。傳回值請參見 DbType 參數說明。	POLARDB
OwnerNameList	object
OwnerNames	array	邏輯庫 Owner 的暱稱列表。
	string	邏輯庫 Owner 的暱稱。	owner_name
Logic	boolean	是否為邏輯庫，傳回值為 true。	true
SchemaName	string	邏輯庫名。	test_logic_db
SearchName	string	邏輯庫搜尋名。	test_logic_db[test_logic_alias]
EnvType	string	環境類型，傳回值如下： product：生產環境 dev：開發環境 pre：預發環境 test：測試環境 sit：SIT 環境 uat：UAT 環境 pet：壓測環境 stag：STAG 環境	dev
Alias	string	邏輯庫別名。	test_logic_alias
DatabaseIds	object
DatabaseIds	array	邏輯庫分庫 ID 列表。
	integer	邏輯庫分庫 ID。	12****
RequestId	string	請求 ID。	90260530-565C-42B9-A6E8-893481FE6AB6
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

{
  "LogicDatabase": {
    "DatabaseId": "1***",
    "OwnerIdList": {
      "OwnerIds": [
        "51****"
      ]
    },
    "DbType": "POLARDB",
    "OwnerNameList": {
      "OwnerNames": [
        "owner_name"
      ]
    },
    "Logic": true,
    "SchemaName": "test_logic_db",
    "SearchName": "test_logic_db[test_logic_alias]",
    "EnvType": "dev",
    "Alias": "test_logic_alias",
    "DatabaseIds": {
      "DatabaseIds": [
        0
      ]
    }
  },
  "RequestId": "90260530-565C-42B9-A6E8-893481FE6AB6",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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