巡檢項：查詢
更新時間 2024-09-25 16:21:01
最近更新時間: 2024-09-25 16:21:01
分享文章
智能巡檢
巡檢項：查詢
接口功能介紹
調用此接口可查詢巡檢項。
接口約束
無
URI
GET /v4/monitor/intelligent-inspection/query-inspection-item
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| inspectionType | 否 | Integer | 本參數表示巡檢類型。取值范圍：1：資源健康評估。2：資源風險識別。根據以上范圍取值。 | 1 | |
| search | 否 | String | 模糊搜索 | 云主機 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| inspectionItemList | Array of Objects | 巡檢項列表 | inspectionItemObj |
表 inspectionItemObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| productType | String | 本參數表示產品類型。取值范圍：vm：云主機。根據以上范圍取值。 | vm | |
| inspectionType | Integer | 本參數表示巡檢類型。取值范圍：1：資源健康評估。2：資源風險識別。根據以上范圍取值。 | 1 | |
| inspectionItem | Integer | 本參數表示巡檢項。取值范圍：1：云主機性能評估。2：監控數據健康評估。3：云主機閑置資源檢查。4：云主機磁盤使用預警評估根據以上范圍取值。 | 1 | |
| inspectionItemName | String | 本參數表示巡檢項名稱 | 云主機性能評估 | |
| level | Integer | 本參數表示重要等級。取值范圍：1：低。2：中。3：高。根據以上范圍取值。 | 2 | |
| description | String | 巡檢項描述 | 云主機磁盤空間耗盡風險 | |
| status | Boolean | 本參數表示巡檢項狀態。取值范圍：true：正常。false：異常。根據以上范圍取值。 | true | |
| inspectionRules | Array of Objects | 巡檢規則列表 | inspectionRule |
表 inspectionRule
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| monitorItem | String | 監控項 | cpu_util | |
| period | Integer | 巡檢周期，在不同巡檢項中對應巡檢天數或預計未來天數 | 3 | |
| fun | String | 本參數表示巡檢算法。取值范圍：avg：平均值算法。max：最大值算法。min：最小值算法。根據以上范圍取值。 | avg | |
| operator | String | 本參數表示比較符。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根據以上范圍取值。 | gt | |
| monitorValue | Double | 閾值 | 87.5 |
請求示例
請求url
/v4/monitor/intelligent-inspection/query-inspection-item?inspectionType=2
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"returnObj":{
"inspectionItemList":[
{
"productType":"vm",
"inspectionType":2,
"inspectionItem":4,
"inspectionItemName":"云主機磁盤使用預警評估",
"level":2,
"description":"云主機磁盤空間耗盡風險",
"status":true,
"inspectionRules":[
{
"monitorItem":"disk_util",
"period":7,
"fun":"max",
"operator":"gt",
"monitorValue":87.5
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
