Query the Performance Data of an Instance
API Introduction
Call the describeDBInstancePerformance API to query MongoDB instance performance data.
API Restrictions
None
URI
GET /v1/openApi/describeDBInstancePerformance
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
resId | Yes | String | Instance ID identification | 59 | |
beginTime | No | String | Start time, if left blank, default to 30 | 10 | |
timeSpan | No | String | Time unit, if left blank, default to min | min |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | String | Return code Value range: 800 indicates success | 800 | |
message | Yes | String | Return to Messages | ||
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
wiredTigerCachePagesRead | Yes | Object | Frequency of writing to WiredTiger memory | ||
wiredTigerCacheTracked | Yes | Object | Amount of dirty data in memory (WiredTiger engine) | ||
metricsDocumentUpdatedPersecond | Yes | Object | Document updates per second | ||
assertsRegularPersecond | Yes | Object | Assertions added per second | ||
extraInfoPageFaults | Yes | Object | Number of page faults | ||
assertsWarningPersecond | Yes | Object | Warnings per second | ||
networkBytesoutPersecond | Yes | Object | Bytes sent per second | ||
opcountersQueryPersecond | Yes | Object | Query operations per second | ||
opcountersReplQueryPersecond | Yes | Object | Replica query operations per second from the node | ||
opcountersReplUpdatePersecond | Yes | Object | Replica update operations per second from the node | ||
globalLockCurrentQueueWriters | Yes | Object | Number of queues currently waiting for write lock | ||
opcountersDeletePersecond | Yes | Object | Delete operations per second | ||
replOplogWin | Yes | Object | Time available in the master node's oplog (s) | ||
networkNumrequestsPersecond | Yes | Object | Requests per second | ||
opcountersReplCommandPersecond | Yes | Object | Replica command operations per second from the node | ||
wiredTigerCacheBytes | Yes | Object | Amount of data in memory (WiredTiger engine) | ||
memVirtual | Yes | Object | Amount of virtual memory used (MB) | ||
metricsDocumentInsertedPersecond | Yes | Object | Replica delete operations per second from the node | ||
opcountersCommandPersecond | Yes | Object | Operations per second | ||
wiredTigerCachePagesWrite | Yes | Object | Frequency of writing to disk from WiredTiger memory | ||
opcountersGetmorePersecond | Yes | Object | Number of getmore statement operations per second | ||
metricsDocumentDeletedPersecond | Yes | Object | Number of document deletions per second | ||
globalLockCurrentQueue | Yes | Object | Number of queues currently waiting for read lock | ||
replLag | Yes | Object | Active/standby delay (s) | ||
cursorsTotalOpen | Yes | Object | Total number of opened cursors | ||
globalLockCurrentQueueReaders | Yes | Object | Number of queues currently waiting for read lock | ||
assertsMsgPersecond | Yes | Object | Messages per second | ||
oplogSizePh | Yes | Object | The rate at which the active node generates oplog | ||
connectionsCurrent | Yes | Object | Current number of active connections | ||
opcountersUpdatePersecond | Yes | Object | Modify operations per second | ||
opcountersInsertPersecond | Yes | Object | Insert operations per second | ||
opcountersReplGetmorePersecond | Yes | Object | Replica getmore operations per second from the node | ||
createTime | Yes | Object | Time of creation or update | ||
networkBytesinPersecond | Yes | Object | Bytes received per second | ||
replHeadroom | Yes | Object | Active/standby oplog overlap duration (s) | ||
cursorsTimeOut | Yes | Object | Number of timeout cursors | ||
assertsUserPersecond | Yes | Object | User assertions per second |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeDBInstancePerformance?resId=59&beginTime=10&timeSpan=min
Response Example
{
"statusCode":800,
"message":"the MongoD instance performance data is queried successfully",
"returnObj":{
"wiredTigerCachePagesRead":[17,17,17,17,17,17,17,17,17,17,17],
"wiredTigerCacheTracked":[4,0,0,0,0,0,0,0,0,0,0],
"metricsDocumentUpdatedPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"assertsRegularPersecond":[0,0,0,0,0,0,0,0,0,0,0],"extraInfoPageFaults":[0,0,0,0,0,0,0,0,0,0,0],
"assertsWarningPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"networkBytesoutPersecond":[30,30,30,30,30,30,30,30,30,30,30],
"opcountersQueryPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersReplQueryPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersReplUpdatePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"globalLockCurrentQueueWriters":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersDeletePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"replOplogWin":[0,0,0,0,0,0,0,0,0,0,0],
"networkNumrequestsPersecond":[2,2,2,2,2,2,2,2,1,2,1],
"opcountersReplCommandPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"wiredTigerCacheBytes":[8562324,8562324,8562324,8562324,8562324,8571143,8571143,8571143,8571143,8571143,8579893],
"memVirtual":[913,913,913,913,913,913,913,913,913,913,913],
"opcountersReplDeletePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"metricsDocumentInsertedPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersCommandPersecond":[2,2,2,2,2,2,2,2,1,2,1],
"wiredTigerCachePagesWrite":[13786,13796,13796,13796,13796,13806,13806,13806,13806,13806,13816],
"opcountersGetmorePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"metricsDocumentDeletedPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"globalLockCurrentQueue":[0,0,0,0,0,0,0,0,0,0,0],
"replLag":[0,0,0,0,0,0,0,0,0,0,0],
"cursorsTotalOpen":[0,0,0,0,0,0,0,0,0,0,0],
"memResident":[95,95,95,95,95,95,95,95,95,95,95],
"globalLockCurrentQueueReaders":[0,0,0,0,0,0,0,0,0,0,0],
"assertsMsgPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersReplInsertPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"oplogSizePh":[0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0],
"connectionsCurrent":[2,2,2,2,2,2,2,2,2,2,2],
"metricsDocumentReturnedPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersUpdatePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersInsertPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"opcountersReplGetmorePersecond":[0,0,0,0,0,0,0,0,0,0,0],
"createTime":["07/26 15:55","07/26 15:56","07/26 15:57","07/26 15:58","07/26 15:59","07/26 16:00","07/26 16:01","07/26 16:02","07/26 16:03","07/26 16:04","07/26 16:05"],
"networkBytesinPersecond":[0,0,0,0,0,0,0,0,0,0,0],
"replHeadroom":[0,0,0,0,0,0,0,0,0,0,0],
"cursorsTimeOut":[0,0,0,0,0,0,0,0,0,0,0],
"assertsUserPersecond":[0,0,0,0,0,0,0,0,0,0,0]
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None