查詢Postgresql實例列表
更新時間 2022-11-28 15:28:33
最近更新時間: 2022-11-28 15:28:33
分享文章
接口描述
分頁查詢實例列表。
請求方法
GET
URI
/v1/product/page-paas-product
請求參數
| 名稱 | 位置 | 類型 | 必選 | 說明 |
|---|---|---|---|---|
| pageNum | query | Integer | 是 | 當前頁 |
| pageSize | query | Integer | 是 | 頁大小,范圍1-500 |
| prodInstName | query | string | 否 | 實例名稱,支持模糊匹配 |
響應參數
| 名稱 | 二級子節點 | 三級子節點 | 類型 | 說明 |
|---|---|---|---|---|
| message | String | 消息提示 | ||
| statusCode | Integer | 狀態碼 | ||
| returnObj | Object | 所有的返回信息都以JSON形式保存 | ||
| pageNum | Integer | 當前頁 | ||
| pageSize | Integer | 頁大小 | ||
| total | Integer | 總記錄數 | ||
| pageTotal | Integer | 總頁數 | ||
| list | Array | 實例列表 | ||
| createTime | Long | 創建時間 | ||
| prodDbEngine | String | 數據庫實例引擎 | ||
| prodInstId | Long | 實例id | ||
| prodInstName | String | 實例名稱 | ||
| prodRunningStatus | Integer | 實例當前的運行狀態 0:運行中 1->重啟中 2:備份中 3:恢復中 4:修改參數中 5:使用參數分組 6:擴展處理 7:擴展完成 8:修改端口中 9:切換主備中 |
||
| alive | Integer | 實例是否存活, 0:存活,-1:異常 優先級依次遞減prodOrderStatus > prodRunningStatus > alive, 前面為0的情況下才會取下一個狀態位 |
||
| prodOrderStatus | Integer | 訂單狀態,0:正常,1:凍結,2:刪除,3:操作中,4:失敗 | ||
| prodType | Integer | 實例部署方式0:單機部署,1:主備部署 | ||
| readPort | Integer | 讀端口 | ||
| vip | String | 虛擬ip地址 | ||
| writePort | String | 寫端口 |
示例
請求示例
/v1/product/page-paas-product?pageNum=1&pageSize=10
響應示例
{
"message": "SUCCESS",
"returnObj": {
"list": [
{
"alive": 0,
"createTime": 1663312182000,
"prodDbEngine": "12.3",
"prodInstId": 10,
"prodInstName": "pg-test-s3",
"prodOrderStatus": 0,
"prodRunningStatus": 2,
"prodType": 1,
"readPort": 5210,
"vip": "192.168.1.14",
"writePort": 5220
},
{
"alive": 0,
"createTime": 1663312500000,
"prodDbEngine": "12.3",
"prodInstId": 12,
"prodInstName": "PGSql-9r3e",
"prodOrderStatus": 0,
"prodRunningStatus": 0,
"prodType": 1,
"readPort": 5632,
"vip": "192.168.1.13",
"writePort": 5432
}
],
"pageNum": 1,
"pageSize": 10,
"pageTotal": 1,
"total": 2
},
"statusCode": 800
}
錯誤碼
訪問ErrorCodes說明文檔查看更多錯誤碼。