接口功能介绍
调用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 | 表示请求失败 |
错误码
无
