mongocli cloud-manager metrics disks describe¶
The metrics disks describe
command lists the available
metrics for a specified partition on a specified MongoDB Cloud Manager host.
You can get a list of partition names for a host with the
metrics disks list
command. You can get the host IDs associated with a particular MongoDB Cloud Manager
project with the process list command.
Syntax¶
mongocli cloud-manager|cm metrics disks describe <hostID> <partition-name> --granularity <granularity> --period <period> --start <start> --end <end> [--limit <number>] [--page <number>] [--type <type>] [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Note
Use -h
or --help
to view the command-line help for
this command.
Options¶
Note
You must specify either:
period
orstart
andend
.
Option | Type | Description | Required? |
---|---|---|---|
<partition-name> | string | The name of the disk or partition for which to get available metrics. | yes |
end | String | The time at which to stop retrieving metrics, as specified by an
ISO-8601 timestamp string. If you specify end , you must also
specify start . Mutually exclusive with period . | yes |
granularity | String | An ISO-8601-formatted time period that specifies the interval
between metric data points. For example, The following subset of ISO-8601-formatted time periods are supported:
| yes |
<hostID> | String | The host ID of the server running the MongoDB process. | yes |
--limit | number | Number of items per page. | no |
--output , -o | string | Command output format. Valid values are:
If omitted, the command returns output in the default format. | no |
--page | number | Page number | no |
period | String | An ISO-8601-formatted time period that specifies the length of time in
the past to query. For example, to request the last 36 hours, specify:
period=P1DT12H . Mutually exclusive with start and end . | yes |
--profile , -P | string | Name of the profile where the project ID and the Programmatic API Key |