API Introduction
Call describeHostAlarmConfig to query the instance host alarm rules.
API Restrictions
None
URI
GET /v1/alarmOpenApi/describeHostAlarmConfig
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Yes | String | External instance ID of the document database | 60d420bffb394397b4303be871a481e3 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The host alarm rules of the MongoDB instance are queried successfully | |
returnObj | Yes | Object[] | Return object array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstId | Yes | String | Instance ID | 60d420bffb394397b4303be871a481e3 | |
id | Yes | Integer | Flag value | 62 | |
machineId | Yes | Integer | The id of the flag machine | 62 | |
userId | Yes | Long | User id | 1012 | |
host | Yes | String | The ip address of the machine | 172.31.207.233 | |
vpcIp | Yes | String | The vpc ip address of the machine | 192.168.0.32 | |
monitor | Yes | Byte | Whether it is monitored, 1 means monitored | 1 | |
alarmOsCpu | Yes | Byte | cpu alarm | 1 | |
alarmOsDisk | Yes | Byte | Disk alarm | 1 | |
alarmOsMemory | Yes | Byte | Memory alarm | 1 | |
thresholdWarningOsCpu | Yes | Integer | cpu alarm threshold | 80 | |
thresholdWarningOsDisk | Yes | Integer | Disk alarm threshold | 75 | |
thresholdWarningOsMemory | Yes | Integer | Memory alarm threshold | 85 | |
thresholdCriticalOsCpu | Yes | Integer | cpu critical threshold | 90 | |
thresholdCriticalOsDisk | Yes | Integer | Disk critical threshold | 90 | |
thresholdCriticalOsMemory | Yes | Integer | Memory critical threshold | 95 |
Sample Request
Request Header
None
Request parameter query
/v1/alarmOpenApi/describeHostAlarmConfig?prodInstId=60d420bffb394397b4303be871a481e3
Response Example
{
"statusCode": 800,
"message": "the host alarm rules of the MongoDB instance are queried successfully",
"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
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None