接口功能介绍
调用modifyHostAlarmConfig修改MongoDB实例的主机告警规则。
接口约束
无
URI
POST /v1/alarmOpenApi/modifyHostAlarmConfig
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 实例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 实例ID | e3d802458aa848b98f45689f143761a8 | |
monitor | 否 | String | 是否被监控,1代表被监控 | 1 | |
alarmOsCpu | 否 | String | 是否监控cpu,1代表监控 | 1 | |
alarmOsDisk | 否 | String | 是否监控磁盘,1代表监控 | 1 | |
alarmOsMemory | 否 | String | 是否监控内存,1代表监控 | 1 | |
thresholdWarningOsCpu | 否 | String | cpu警告阈值,不填则默认80 | 60 | |
thresholdCriticalOsCpu | 否 | String | cpu紧急阈值,不填则默认90 | 90 | |
thresholdWarningOsDisk | 否 | String | 磁盘警告阈值,不填则默认75 | 75 | |
thresholdCriticalOsDisk | 否 | String | 磁盘紧急阈值,不填则默认90 | 90 | |
thresholdWarningOsMemory | 否 | String | 内存警告阈值,不填则默认85 | 85 | |
thresholdCriticalOsMemory | 否 | String | 内存紧急阈值,不填则默认95 | 95 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
---|---|---|---|---|---|
statusCode | 是 | Integer | 响应码 取值范围:800为成功,900为失败 |
800 | |
message | 是 | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ProdInstId | 是 | String | 实例ID | e3d802458aa848b98f45689f143761a8 | |
ModifyHostAlarmConfig | 是 | String | 是否修改成功,成功返回success | success |
请求示例
请求头header
无
请求体body
{
"prodInstId":"e3d802458aa848b98f45689f143761a8",
"thresholdWarningOsCpu":60
}
响应示例
{
"statusCode": 800,
"message": "修改MongoDB实例的主机告警规则成功",
"returnObj": {
"ModifyHostAlarmConfig": "success",
"ProdInstId": "e3d802458aa848b98f45689f143761a8"
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
无