查詢PolarDB集群的數據庫賬號信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:DescribeAccounts | READ |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-*************** |
| AccountName | string | 否 | 賬號名稱。 | test_acc |
| PageNumber | integer | 否 | 頁碼，取值范圍為大于 0 但不超過 Integer 最大值的整數。默認值為 1。 | 1 |
| PageSize | integer | 否 | 每頁記錄數，取值范圍：
默認值為 30。 | 30 |
返回參數
示例
正常返回示例
JSON格式
{
"PageRecordCount": 1,
"RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
"PageNumber": 1,
"Accounts": [
{
"AccountStatus": "Available",
"DatabasePrivileges": [
{
"DBName": "DBtest",
"AccountPrivilege": "ReadOnly"
}
],
"AccountDescription": "test",
"AccountPasswordValidTime": "undefined",
"AccountType": "Normal",
"AccountLockState": "UnLock",
"AccountName": "test_acc"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 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 | 數據庫實例連接失敗，請檢查實例狀態和數據庫進程列表 |
| 400 | Account.QueryError | Instance %s query account error | 實例%s查詢帳戶錯誤 |
| 400 | Connect.Timeout | Service can not connect to instance temporarily. | 服務暫時無法連接到實例 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數DBClusterId無效 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-11-03 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-06-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-04-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |