edit-icon download-icon

DescribeDBInstancePerformance

Last Updated: Nov 22, 2018

Description

This API supports both replica set instances and sharded cluster instances.

Input parameters

NameTypeRequiredDescription
ActionStringYesRequired parameter; value: DescribeDBInstancePerformance.
DBInstanceIdStringYesInstance ID
NodeIdStringNo- This parameter is required for shared cluster instances.
- Input Mongos or shard node instance IDs to query the performance of a single component.
- This parameter is not required for single-node and three-node instances.
StartTimeStringYesQuery start timeFormat: yyyy-MM-dd’T’HH:mmZ. For example, 2011-05-30T12:11ZTime format: GMT
EndTimeStringYesQuery end timeFormat: yyyy-MM-dd’T’HH:mmZFor example, 2011-05-30T12:11ZTime format: GMT
ReplicaSetRoleStringYesReplica set roles; value: Primary or Secondary.
KeyStringYesPerformance indicator. Multiple indicators are separated by the commas (,). For more information, see the Performance Parameter Table.

Response parameters

NameTypeDescription
Public response parameters-For more information, see public response parameters.
DBInstanceIdStringInstance ID
EngineStringDatabase type
StartTimeStringQuery start time in the format of YYYYMM-DD’T’HH:mmZ. For example: 2011- 05-30T03:29Z
EndTimeStringQuery end time in the format of YYYYMM-DD’T’HH:mmZ. For example: 2011- 05-30T03:29Z. It must be later than the start time.
PerformanceKeysList<PerformanceKey>Array format: {perf1, perf2, perf3, …}.

PerformanceKey parameters

NameTypeDescription
KeyStringPerformance parameter
UnitStringDisplay unit
ValueFormatStringValue format.
- If it is null, VALUE is a final value.
- If it is not null, VALUE needs to be resolved and separated with “&”, for example, com_delete&com_insert&com_insert_select&com_replace.
ValuesList<PerformanceValue>Array format: {value1, value2, …}

Performance parameter value list PerformanceValue

NameTypeDescription
ValueStringPerformance value
DateStringCalculation date in the format of “yyyy-MMdd’T’HH:mm:ssZ”, for example, 2011-05-30T03:29:00Z.

Performance parameter table

MetricKey
CPU UsageCpuUsage
Memory UsageMemoryUsage
IOPS UsageMongoDB_IOPS
IOPS UsageIOPSUsage
Used Disk SpaceMongoDB_DetailedSpaceUsage
Disk Space UsageDiskUsage
OpcountersMongoDB_Opcounters
ConnectionsMongoDB_Connections
CursorsMongoDB_Cursors
NetWorkMongoDB_Network
GlobalLockMongoDB_Global_Lock_Current_Queue
WiredTigerMongoDB_Wt_Cache
Thank you! We've received your feedback.