Docs Home → MongoDB Command Line Interface
mongocli cloud-manager metrics databases describe
On this page
Describe database measurements for a given host database.
Syntax
Command Syntax
mongocli cloud-manager metrics databases describe <hostId> <name> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
hostId | string | true | Process identifier. You can use mongocli ops-manager processes list to get the ID. |
name | string | true | Database name. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--end | string | false | ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. Mutually exclusive with --period. |
--granularity | string | true | ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. |
-h, --help | false | help for describe | |
--limit | int | false | Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. |
--page | int | false | Page number that specifies a page of results. |
--period | string | false | ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and start/end in the same request Mutually exclusive with --start, --end. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--start | string | false | ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. Mutually exclusive with --period. |
--type | strings | false | Measurements to return. If this is not specified, all measurements are returned. Valid values are DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# List metrics for the database test of the process e4ac1e57c58cc9c8aaa5a1163a851993 mongocli ops-manager metrics database describe e4ac1e57c58cc9c8aaa5a1163a851993 test --period P1DT12H --granularity PT5