mongocli atlas metrics disks describe¶
The metrics disks describe
command lists the available
metrics for a specified partition on a specified Atlas host.
You can get a list of partition names for a host with the
metrics disks list
command. You can get the hostnames associated with a particular Atlas
project with the process list command.
Syntax¶
mongocli atlas metrics disks describe <hostname>:<port> <partition-name> --granularity <granularity> --period <period> --start <start> --end <end> [--type <type>] [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Use -h
or --help
to view the command-line help for
this command.
Options¶
Option | Type | Description | Required? | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<hostname>:<port> | String | The hostname of the server running the Atlas MongoDB process
and the port on which the process listens. | yes | ||||||||||
<partition-name> | string | The name of the disk or partition for which to get available metrics. | yes | ||||||||||
--granularity | String | An ISO-8601-formatted time period that specifies the interval
between measurement data points. For example, The following subset of ISO-8601-formatted time periods are supported:
When you specify | yes | ||||||||||
--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 | ||||||||||
--start | String | The time at which to start retrieving metrics, as specified by an
ISO-8601 timestamp string. If you specify start , you must also
specify end . Mutually exclusive with period . | 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 | ||||||||||
--type | String | Specifies which measurement to return. If You must specify a measurement that is valid for the host. Atlas returns an error if a specified measurement is invalid. The following measurement values are valid:
| no | ||||||||||
--output , -o | string | Command output format. Valid values are:
If omitted, the command returns output in the default format. | no | ||||||||||
--profile , -P | string | Name of the profile where the project ID and the Programmatic API Key |