查詢實例主機告警規則
更新時間 2023-08-29 15:13:54
最近更新時間: 2023-08-29 15:13:54
分享文章
接口功能介紹
調用describeHostAlarmConfig查詢實例主機告警規則。
接口約束
無
URI
GET /v1/alarmOpenApi/describeHostAlarmConfig
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394397b4303be871a481e3 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢MongoDB實例的主機告警規則成功 | |
| returnObj | 是 | Object[] | 返回對象數組 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 實例ID | 60d420bffb394397b4303be871a481e3 | |
| id | 是 | Integer | 標志值 | 62 | |
| machineId | 是 | Integer | 標志機器的id | 62 | |
| userId | 是 | Long | 用戶id | 1012 | |
| host | 是 | String | 機器的ip地址 | 172.31.207.233 | |
| vpcIp | 是 | String | 機器的vpc ip地址 | 192.168.0.32 | |
| monitor | 是 | Byte | 是否被監控，1代表被監控 | 1 | |
| alarmOsCpu | 是 | Byte | cpu告警 | 1 | |
| alarmOsDisk | 是 | Byte | 磁盤告警 | 1 | |
| alarmOsMemory | 是 | Byte | 內存告警 | 1 | |
| thresholdWarningOsCpu | 是 | Integer | cpu告警閾值 | 80 | |
| thresholdWarningOsDisk | 是 | Integer | 磁盤告警閾值 | 75 | |
| thresholdWarningOsMemory | 是 | Integer | 內存告警閾值 | 85 | |
| thresholdCriticalOsCpu | 是 | Integer | cpu緊急閾值 | 90 | |
| thresholdCriticalOsDisk | 是 | Integer | 磁盤緊急閾值 | 90 | |
| thresholdCriticalOsMemory | 是 | Integer | 內存緊急閾值 | 95 |
請求示例
請求頭header
無
請求參數query
/v1/alarmOpenApi/describeHostAlarmConfig?prodInstId=60d420bffb394397b4303be871a481e3
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例的主機告警規則成功",
"returnObj": [
{
"thresholdCriticalOsCpu": 90,
"thresholdCriticalOsDisk": 90,
"vpcIp": "192.168.0.32",
"alarmOsCpu": 1,
"monitor": 1,
"thresholdCriticalOsMemory": 95,
"thresholdWarningOsDisk": 75,
"userId": 1012,
"alarmOsDisk": 1,
"alarmOsMemory": 1,
"machineId": 62,
"host": "172.31.207.233",
"thresholdWarningOsMemory": 85,
"prodInstId": "60d420bffb394397b4303be871a481e3",
"id": 62,
"thresholdWarningOsCpu": 80
}
]
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
