Navigation

mongocli atlas cluster describe

On this page

The cluster describe command retrieves details about the specified cluster in the specified Atlas project. You can also retrieve details about a cluster through the Atlas UI or API.

Syntax

mongocli atlas cluster describe <cluster-name>
     [ --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

Option Type Description Required?
<cluster-name> string Name of the cluster to retrieve. yes
--output, -o string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

no
--profile, -P string Name of the profile where the public and private keys for the project are set. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI. no
--projectId string Unique identifier of the project that contains the cluster to update. If omitted, uses the project ID in the profile or environment variable. no

Output

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.

Field Returned Value
autoScaling Configuration for automatically scaling cluster storage and tier.
autoscaling
.diskGBEnabled

State of this cluster’s disk auto-scaling:

  • true if enabled
  • false if disabled

By default, Atlas disables disk auto-scaling.

backupEnabled

State of cloud backup for this cluster:

  • true if enabled
  • false if disabled
biConnector Configuration for BI Connector for Atlas on the cluster.
biConnector
.enabled

State of BI Connector for the cluster:

  • true if enabled
  • false if disabled

The default value is false.

biConnector
.readPreference

Read preference for BI Connector on the cluster:

clusterType

Type of cluster:

  • REPLICASET
  • SHARDED
  • GEOSHARDED
diskSizeGB Capacity, in GB, of the host’s root volume.
encryptionAtRestProvider Configuration for encryption at rest.
id Unique identifier of the cluster.
groupId

Unique identifier of the project.

Note

Your project ID equals groupId.

labels Returns identifying tags for the cluster. As of version 1.0.0, MongoDB uses this field to track use of monogcli.
mongoDBVersion MongoDB version that is deployed.
mongoDBMajorVersion Major version of MongoDB that is deployed.
mongoURI Base connection string for the cluster.
MongoURIUpdated Timestamp in Timestamp in ISO 8601 date and time format in UTC when someone last updated the connection string.
name Name of the cluster.
numShards

Number of shards in the cluster:

  • 1: replica set.
  • Between 2 and 12 inclusive: sharded cluster.
paused

State of the cluster:

  • true if cluster is paused.
  • false if cluster is active.
providerBackupEnabled

State of Cloud Backup for the cluster:

  • true if enabled.
  • false if disabled.
providerSettings Configuration for the provisioned servers on which MongoDB runs.
providerSettings
.backingProviderName

Cloud provider service on which the servers are provisioned:

  • AWS for Amazon AWS
  • GCP for Google Cloud Platform
  • AZURE for Microsot Azure
providerSettings
.instanceSizeName

Name of the cluster tier used for Atlas cluster:

Cluster Tiers Default Storage Default RAM
M2 2 GB Shared
M5 5 GB Shared
M10 10 GB 2 GB
M20 20 GB 4 GB
M30 40 GB 8 GB
M40 or R40 80 GB 16 GB
M40_NVME 380 GB 15.25 GB
M50 or R50 160 GB 32 GB
M50_NVME 760 GB 30.5 GB
M60 or R60 320 GB 64 GB
M60_NVME 1.6 TB 61 GB
M80 760 GB 131 GB
R80 750 GB 122 GB
M80_NVME 1.6 TB 122 GB
M100 1 TB 160 GB
M140 1 1 TB 192 GB
M200 or R200 1.5 TB 256 GB
M200_NVME 3.1 TB 244 GB
M300 1 2 TB 384 GB
R300 2 TB 384 GB
R400 3 TB 488 GB
M400_NVME 2 4 TB 512 GB
R700 4 TB 768 GB

1 Unavailable if providerSettings.regionName equals AP_SOUTHEAST_2.

2 Availability limited to the following regions: - US_EAST_1 - US_EAST_2 - US_WEST_2 - EU_WEST_1 - EU_CENTRAL_1 - AP_NORTHEAST_1

Cluster Tiers Default Storage Default RAM
M2 2 GB Shared
M5 5 GB Shared
M10 32 GB 2 GB
M20 32 GB 4 GB
M30 32 GB 8 GB
M40 128 GB 16 GB
M50 128 GB 32 GB
M60 128 GB 64 GB
M80 256 GB 128 GB
M200 256 GB 256 GB
Cluster Tiers Default Storage Default RAM
M2 2 GB Shared
M5 5 GB Shared
M10 10 GB 1.70 GB
M20 20 GB 3.75 GB
M30 40 GB 7.5 GB
M40 80 GB 15 GB
M50 160 GB 30 GB
M60 320 GB 60 GB
M80 750 GB 120 GB
M200 1.5 TB 240 GB
M300 1 2.2 TB 360 GB

1 Unavailable if providerSettings.regionName equals: - SOUTH_AMERICA_EAST_1 - EUROPE_WEST_3 - NORTHEASTERN_ASIA_PACIFIC - AUSTRALIA_SOUTHEAST_1

providerSettings
.providerName

Name of the cloud service provider on which Atlas provisioned the MongoDB host:

  • AWS for Amazon AWS
  • GCP for Google Cloud Platform
  • AZURE for Microsot Azure
providerSettings
.regionName

Physical location of the cluster.

For a complete list of regions, see cloud provider reference:

replicationFactor Number of replica set members in the cluster: 3, 5, or 7.
replicationSpec Configuration for each region in the cluster. Each element in this object represents a region where Atlas deployed your cluster.
replicationSpec
.<region>

Physical location of the region.

Each <region> object describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

replicationSpec
.<region>.analyticsNodes
Number of analytics nodes in the region.
replicationSpec
.<region>.electableNodes
Number of electable nodes in the region.
replicationSpec
.<region>.priority
Election priority of the region as an integer between 0 and 7 inclusive.
replicationSpec
.<region>.readOnlyNodes
Number of read-only nodes in the region.
replicationSpecs

Returns Global Cluster zone. As mongocli can’t create Global Clusters, this response includes one zone only.

Each object in this array represents a zone where Atlas deploys nodes for your Global Cluster.

replicationSpecs.id Unique identifier of the replication object.
replicationSpecs.numShards Number of shards to deploy in the specified zone.
replicationSpecs.zoneName Name for the zone.
replicationSpecs.regionConfig Configuration for the physical location of the region. Each regionsConfig object describes the region’s priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.analyticsNodes
Number of analytics nodes to deploy in the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.electableNodes
Number of electable nodes for Atlas to deploy to the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.priority
Election priority of the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.readOnlyNodes
Number of read-only nodes for Atlas to deploy to the region.
srvAddress connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS. The mongoURI parameter lists additional options.
stateName

Current status of the cluster:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING

Examples

The following example uses the mongocli atlas cluster describe command to retrieve details about a cluster named myCluster. It uses the default profile to access the Atlas project that contains the cluster.

mongocli atlas cluster describe myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json

The example command prints the following fields to the terminal. To learn more about these fields, see Output.

{
     "autoScaling": {
             "diskGBEnabled": false
     },
     "backupEnabled": false,
     "biConnector": {
             "enabled": false,
             "readPreference": "secondary"
     },
     "clusterType": "REPLICASET",
     "diskSizeGB": 2,
     "encryptionAtRestProvider": "NONE",
     "id": "5e2f56937a3e5a26326a5ee8",
     "groupId": "5e2211c17a3e5a48f5497de3",
     "mongoDBVersion": "4.2.3",
     "mongoDBMajorVersion": "4.2",
     "mongoURI": "mongodb://mycluster-shard-00-00-7hgjn.mongodb-dev.net:27017,mycluster-shard-00-01-7hgjn.mongodb-dev.net:27017,mycluster-shard-00-02-7hgjn.mongodb-dev.net:27017",
     "mongoURIUpdated": "2020-01-27T21:33:07Z",
     "mongoURIWithOptions": "mongodb://mycluster-shard-00-00-7hgjn.mongodb-dev.net:27017,mycluster-shard-00-01-7hgjn.mongodb-dev.net:27017,mycluster-shard-00-02-7hgjn.mongodb-dev.net:27017/?ssl=true\u0026authSource=admin\u0026replicaSet=myCluster-shard-0",
     "name": "myCluster",
     "numShards": 1,
     "paused": false,
     "providerBackupEnabled": false,
     "providerSettings": {
             "backingProviderName": "AWS",
             "instanceSizeName": "M2",
             "providerName": "TENANT",
             "regionName": "US_EAST_1"
     },
     "replicationFactor": 3,
     "replicationSpec": {
             "US_EAST_1": {
                     "analyticsNodes": 0,
                     "electableNodes": 3,
                     "priority": 7,
                     "readOnlyNodes": 0
             }
     },
     "replicationSpecs": [
             {
                     "id": "5e2f56937a3e5a26326a5ee3",
                     "numShards": 1,
                     "zoneName": "Zone 1",
                     "regionsConfig": {
                             "US_EAST_1": {
                                     "analyticsNodes": 0,
                                     "electableNodes": 3,
                                     "priority": 7,
                                     "readOnlyNodes": 0
                             }
                     }
             }
     ],
     "srvAddress": "mongodb+srv://mycluster-7hgjn.mongodb-dev.net",
     "stateName": "IDLE"
}