DescribeDatabases - 查詢PolarDB指定叢集的資料庫詳情 -

查詢PolarDB指定叢集的資料庫詳情。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDatabases

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	pc-**************
DBName	string	否	資料庫名。說明不支援填入多個資料庫名稱。	test_db
PageNumber	integer	否	頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數，預設值為 1。	1
PageSize	integer	否	每頁記錄數，取值範圍如下： 30 50 100 預設值為 30。	30

返回參數

名稱	類型	描述	樣本值
	object
PageRecordCount	integer	本頁記錄數。	1
Databases	object
Database	array<object>	資料庫資訊詳情。
	array<object>
DBDescription	string	資料庫備忘。	test_des
DBStatus	string	資料庫狀態，取值範圍如下： Creating：建立中 Running：使用中 Deleting：刪除中	Running
DBName	string	資料庫名稱。	test_db
Engine	string	資料庫引擎類型，取值範圍如下： MySQL Oracle PostgreSQL	MySQL
MasterID	string	多主叢集（庫表）版的資料庫所對應的主節點 ID。	2
CharacterSetName	string	字元集，詳情請參見字元集表。	utf8mb4
Accounts	object
Account	array<object>	資料庫帳號資訊詳情。說明當叢集為 PolarDB MySQL 版時，不含高許可權帳號。
	object
PrivilegeStatus	string	授權狀態，取值範圍如下： Empowering：授權中 Empowered：授權完成 Removing：移除許可權中	Empowered
AccountStatus	string	帳號狀態，取值範圍如下： Creating：建立中 Available：可用 Deleting：刪除中	Available
AccountPrivilege	string	帳號許可權，取值範圍如下： ReadWrite：讀寫 ReadOnly：唯讀 DMLOnly：只允許 DML DDLOnly：只允許 DDL ReadIndex：唯讀+索引	ReadOnly
AccountName	string	帳號名稱。說明當叢集為 PolarDB MySQL 版時，不含高許可權帳號。	test_acc
RequestId	string	請求 ID。	E1DF8CA6-2300-448B-9ABF-760C4B******
PageNumber	integer	頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "PageRecordCount": 1,
  "Databases": {
    "Database": [
      {
        "DBDescription": "test_des",
        "DBStatus": "Running",
        "DBName": "test_db",
        "Engine": "MySQL",
        "MasterID": "2",
        "CharacterSetName": "utf8mb4",
        "Accounts": {
          "Account": [
            {
              "PrivilegeStatus": "Empowered",
              "AccountStatus": "Available",
              "AccountPrivilege": "ReadOnly",
              "AccountName": "test_acc"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "E1DF8CA6-2300-448B-9ABF-760C4B******",
  "PageNumber": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的參數PageSize無效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的參數PageNumber無效
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	資料庫執行個體串連失敗，請檢查執行個體狀態和資料庫進程列表
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。

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

變更歷史

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