DescribeDbList - PolarDB

呼叫 DescribeDbList 介面取得資料庫清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeDbList

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所屬的地域 ID。	cn-hangzhou
DBInstanceName	string	是	執行個體名稱。	pxc-********
DBName	string	否	資料庫名稱。	db_name

返回參數

名稱	類型	描述	樣本值
	object
Message	string	返回資訊，成功返回 success，錯誤返回對應錯誤碼。	Success
RequestId	string	請求 ID。	C458B1E8-1683-3645-B154-6BA32080EEA
Success	boolean	請求是否成功。	true
Data	array<object>	資料庫清單。
	array<object>
DBName	string	資料庫名稱。	test
DBDescription	string	資料庫描述。	test
DBInstanceName	string	執行個體名稱。	pxc-********
CharacterSetName	string	字元集。	utf8mb4
Accounts	array<object>	帳戶清單。
	object
AccountPrivilege	string	權限。	ReadWrite
AccountName	string	帳戶名稱。	root4test

樣本

正常返回樣本

JSON格式

{
  "Message": "Success",
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Success": true,
  "Data": [
    {
      "DBName": "test",
      "DBDescription": "test",
      "DBInstanceName": "pxc-********",
      "CharacterSetName": "utf8mb4",
      "Accounts": [
        {
          "AccountPrivilege": "ReadWrite",
          "AccountName": "root4test"
        }
      ]
    }
  ]
}

錯誤碼

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

變更歷史

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