智能巡检
巡检项：查询
接口功能介绍
调用此接口可查询巡检项。
接口约束
无
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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
