Atlas 指标数据库描述
返回指定主机上数据库的测量值。
要返回此命令所需的主机名和端口,请运行 atlas process list
语法
命令语法
atlas metrics databases describe <hostname:port> <databaseName> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
hostname:port | 字符串 | true | 运行 MongoDB 进程的实例的主机名和端口号。 |
数据库名称 | 字符串 | true | 标识要从中检索指标的数据库的标签。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--end | 字符串 | false | ISO 8601 格式的日期和时间,用于指定何时停止检索测量值。 您不能在同一请求中设置此参数和时间段。 与 -- period 互斥。 |
--granularity | 字符串 | true | ISO 8601 格式的持续时间,用于指定测量数据点之间的间隔。 仅支持以下 ISO 8601 格式时间段子集:PT10S、PT1M、PT5M、PT1H、P1D。 指定粒度时,必须指定句点或开始和结束时间。 |
-h,--help | false | 描述帮助 | |
--limit | int | false | 每个结果页面的列项数,最多 500 个。 如果结果超过 500 个,请指定 --page 选项以更改结果页面。 此值默认为 100。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--page | int | false | 指定结果页面的页码。 该值默认为 1。 |
--period | 字符串 | false | ISO 8601 格式的时间段,用于指定要查询的过去时间长度。 您不能在同一请求中设置此参数和开始或结束参数。 与 --start、--end 互斥。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--start | 字符串 | false | ISO 8601 格式的日期和时间,用于指定何时开始检索测量值。 您不能在同一请求中设置此参数和时间段。 与 -- period 互斥。 |
--type | 字符串 | false | 要返回的测量值。 该选项默认返回所有测量值。 有效值包括 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 和 DATABASE_VIEW_COUNT |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
# Return the JSON-formatted database metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 atlas metrics databases describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json