查詢PolarDB邊緣雲資料庫
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBClusterId |
string |
是 |
叢集 ID。 |
pc-************** |
| DBName |
string |
否 |
資料庫名。 |
test_db |
| PageNumber |
integer |
否 |
頁碼,取值範圍為大於 0 但不超過 Integer 最大值的整數,預設值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁記錄數,取值範圍如下:
預設值為 30。 |
30 |
| MaxResults |
integer |
否 |
本次讀取的最巨量資料量。 |
10 |
| NextToken |
string |
否 |
查詢憑證(token),取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢,請不傳。 |
212db86sca4384811e0b5e8707e****** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| PageRecordCount |
integer |
本頁記錄數。 |
7 |
| Databases |
array<object> |
資料庫資訊詳情。 |
|
|
object |
|||
| DBDescription |
string |
資料庫備忘。 |
test_des |
| DBStatus |
string |
資料庫狀態,取值範圍如下:
|
Running |
| DBName |
string |
資料庫名。 |
test_db |
| Engine |
string |
資料庫引擎類型,取值範圍如下:
|
MySQL |
| MasterID |
string |
多主叢集(庫表)版的資料庫所對應的主節點 ID。 |
2 |
| CharacterSetName |
string |
字元集名稱。 |
utf8mb4 |
| Accounts |
array<object> |
資料庫帳號資訊詳情。 說明
當叢集為 PolarDB MySQL 版時,不含高許可權帳號。 |
|
|
object |
|||
| PrivilegeStatus |
string |
授權狀態,取值範圍如下:
|
Empowered |
| AccountStatus |
string |
帳號狀態,取值範圍如下:
|
Available |
| AccountPrivilege |
string |
帳號許可權,取值範圍如下:
|
ReadOnly |
| AccountName |
string |
帳號名稱。 說明
當叢集為 PolarDB MySQL 版時,不含高許可權帳號。 |
test_acc |
| RequestId |
string |
請求 ID。 |
2FED790E-FB61-4721-8C1C-07C627****** |
| PageNumber |
integer |
頁碼。 |
1 |
| MaxResults |
integer |
本次讀取的最巨量資料量。 |
10 |
| NextToken |
string |
查詢憑證(token),取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢,請不傳。 |
212db86sca4384811e0b5e8707e****** |
樣本
正常返回樣本
JSON格式
{
"PageRecordCount": 7,
"Databases": [
{
"DBDescription": "test_des",
"DBStatus": "Running",
"DBName": "test_db",
"Engine": "MySQL",
"MasterID": "2",
"CharacterSetName": "utf8mb4",
"Accounts": [
{
"PrivilegeStatus": "Empowered",
"AccountStatus": "Available",
"AccountPrivilege": "ReadOnly",
"AccountName": "test_acc"
}
]
}
],
"RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
"PageNumber": 1,
"MaxResults": 10,
"NextToken": "212db86sca4384811e0b5e8707e******"
}
錯誤碼
|
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。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。