获取风险检测任务信息
接口功能介绍
获取风险监测任务列表
接口约束
无
URI
GET /v1/risk/listClusterHealthCheckTask
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | 8e3a382e241d11ed957c0242ac110006 | |
pageNum | 否 | Integer | 页码 | 1 | |
pageSize | 否 | Integer | 分页大小 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池 ID | d8bbd132b53a11e9b0e40242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(2000成功,5000系统错误,18xxxx业务错误) | 1000 | |
error | String | 业务错误码,RCC_statusCode | RCC_1000 | |
message | String | 返回结果描述 | invalid param | |
returnObj | Object | 返回数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Integer | 总条数 | 1 | |
current | Integer | 当前页码 | 1 | |
pages | Integer | 总页码 | 1 | |
size | Integer | 分页大小 | 1 | |
records | Array of Objects | 风险监测任务列表 | recordObj |
表 recordObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceId | String | 实例ID | 8e3a382e241d11ed957c0242ac110006 | |
status | String | 任务状态 | success | |
createTime | String | 创建时间 | 2023-10-01 10:00:00 | |
clusterType | String | 集群引擎类型 | nacos | |
spec | String | 集群规格 | 2C4G | |
replica | String | 集群节点数 | 3 | |
version | String | 集群版本 | nacos_1.1.0 | |
score | Integer | 风险监测分数 | 80 | |
updateTime | String | 更新时间 | 2023-10-01 10:00:00 | |
totalRisk | Integer | 总风险项 | 1 | |
riskList | Array of Objects | 风险项 | riskObj |
表 riskObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
description | String | 描述 | 弱密码 | |
situation | String | 现状 | 使用了弱密码 | |
riskName | String | 风险名 | 弱密码 | |
suggestion | String | 建议 | 修改密码 | |
score | Integer | 扣分 | 20 | |
riskLevel | String | 风险级别 | HIGHT/MIDDLE/LOW |
枚举参数
无
请求示例
请求url
http://endponint.cn/v1/risk/listClusterHealthCheckTask?instanceId=1
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"returnObj": {"records": [{"instanceId": "ad68937a003e4afbbdf2100c2f4b6ff0","status": "SUCCESS","createTime": "2023-10-19 14:38:20","clusterType": "zookeeper","replica": "3","version": "zookeeper_1.2","score": 80,"updateTime": "2023-10-19 14:38:25","totalRisk": 1,"riskList": [{"description": "ZooKeeper集群处理请求平均延迟超过5秒,请检查相关业务实时性是否受到影响。","noticeFeature": "","situation": "ZooKeeper集群处理请求平均延迟超过5秒","riskName": "请求平均延迟过大","suggestion": "ZooKeeper集群处理请求平均延迟过大会导致集群性能下降,请根据业务判断是否有扩容需求,请提前规划。","type": 3,"riskCode": "30030","module": "config","riskLevel": "HIGHT","mute": null,"riskType": "config_num","taskId": 1714893726528868353,"score": 20,"rvalues": null}],"spec": "2C4G","totalItem": 3}],"total": 1,"current": 1,"pages": 1,"size": 10},"error": "","message": "SUCCESS","statusCode": 2000}