API Introduction
Call describeDbAlarmConfig to query the instance database alarm configuration.
API Restrictions
URI
GET /v1/alarmOpenApi/describeDbAlarmConfig
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 | |
resId | 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 | |
alarmMongoStatus | Yes | Byte | Database status alarm | 1 | |
alarmThreadsConnected | Yes | Byte | Number of database connections alarm | 1 | |
thresholdWarningThreadsConnected | Yes | Integer | Number of connections warning threshold | 1000 | |
thresholdCriticalThreadsConnected | Yes | Integer | Number of connections critical threshold | 3000 |
Sample Request
Request Header
None
Request parameter query
GET /v1/alarmOpenApi/describeDbAlarmConfig?prodInstId=60d420bffb394397b4303be871a481e3
Response Example
{
"statusCode": 800,
"message": "the database alarm rules of the MongoDB instance are queried successfully",
"returnObj": [
{
"alarmMongoStatus": 1,
"thresholdWarningThreadsConnected": 1000,
"vpcIp": "192.168.0.163",
"alarmThreadsConnected": 1,
"host": "172.31.206.238",
"monitor": 1,
"prodInstId": "60d420bffb394397b4303be871a481e3",
"id": 40,
"resId": 40,
"thresholdCriticalThreadsConnected": 3000,
"userId": 1012
},
{
"alarmMongoStatus": 1,
"thresholdWarningThreadsConnected": 1000,
"vpcIp": "192.168.0.81",
"alarmThreadsConnected": 1,
"host": "172.31.204.111",
"monitor": 1,
"prodInstId": "60d420bffb394397b4303be871a481e3",
"id": 41,
"resId": 41,
"thresholdCriticalThreadsConnected": 3000,
"userId": 1012
},
{
"alarmMongoStatus": 1,
"thresholdWarningThreadsConnected": 1000,
"vpcIp": "192.168.0.32",
"alarmThreadsConnected": 1,
"host": "172.31.207.233",
"monitor": 1,
"prodInstId": "60d420bffb394397b4303be871a481e3",
"id": 42,
"resId": 42,
"thresholdCriticalThreadsConnected": 3000,
"userId": 1012
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None