- API >
- API Resources >
- Clusters
Create One Cluster¶
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups
.
This feature is not available for M0
(Free Tier) clusters. For more
information, see Atlas M0 (Free Tier) Limitations.
The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
Considerations¶
- For a given region in an Atlas project with multi-region clusters
or clusters in multiple regions, there is a limit of
40 MongoDB nodes on all other regions in that project. This limit
applies across all cloud service providers and can be raised upon
request. GCP regions communicating with each other do not count
against this limit.This limit applies even ifExampleIf an Atlas project has:
- 30 nodes in
Region A
- 10 nodes in
Region B
- 5 nodes in
Region C
Region A
orRegion B
. This is because the nodes in those clusters add up to 40, which is the maximum allowed per project. You can add up to 5 nodes inRegion C
while still satisfying the project limit.Regions A, B,
andC
are backed by different cloud service providers.For Atlas projects where every cluster is deployed to a single region, you cannot create a multi-region cluster in that project if there are already 40 or more nodes in that single region unless you request that the limit be raised.Please contact Atlas support for questions or assistance with raising this limit. - 30 nodes in
- If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you must delete that role before creating clusters with an earlier MongoDB version.
- Atlas clusters created after July 2020 use Transport Layer Security (TLS ) protocol version 1.2 by default.
- When you create a cluster, Atlas creates a network container in the project for the cloud provider to which you deploy the cluster if one does not already exist.
Required Roles¶
To use this resource, your API Key must have either the
Organization Owner
or Project Owner
roles.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
POST /groups/{GROUP-ID}/clusters
Request Path Parameters¶
Path Element | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier for the project in which to create the cluster. Each Atlas project supports up to 25 clusters. Please contact Atlas support for questions or assistance regarding the cluster limit. To contact support, select Support from the left-hand navigation bar of the Atlas UI. |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||
---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a prettyprint format. | false | ||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters¶
Body Parameter | Type | Necessity | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
autoScaling | object | Optional | Collection of settings that configures auto-scaling information for the cluster. If you specify the autoScaling object, you must also specify the providerSettings.autoScaling object. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.autoIndexingEnabled | boolean | Optional | Flag that indicates whether autopilot mode for Performance Advisor is enabled. The default is false. Important Autopilot mode is only available if you are enrolled in the Auto Pilot Early Access program. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute | object | Optional | Collection of settings that configure how a cluster might scale its cluster tier and whether the cluster can scale down. Important Cluster tier auto-scaling is not available for clusters using Low CPU or NVME storage classes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute.enabled | boolean | Optional | Flag that indicates whether cluster tier auto-scaling is enabled. The default is false.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute.scaleDownEnabled | boolean | Conditional | Flag that indicates whether the cluster tier may scale down. Atlas requires this parameter if "autoScaling.compute.enabled" : true. If you enable this option, specify a value for providerSettings.autoScaling.compute.minInstanceSize. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.diskGBEnabled | boolean | Optional | Flag that indicates whether disk auto-scaling is enabled. The default is true.
Note Disk auto-scaling is subject to limitations based on the maximum amount of RAM for the selected cluster tier and the oplog size. See Customize Your Storage for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backupEnabled | boolean | Optional | Flag that indicates whether legacy backups have been enabled. Applicable only for Important Clusters running MongoDB If you create a new Atlas cluster and set "backupEnabled" : true, the API responds with an error. This change doesn't affect existing clusters that use legacy backups. Set to true to enable Atlas legacy backups for the cluster. Set to false to disable legacy backups for the cluster. Atlas deletes any stored snapshots. To learn more about snapshot storage, see the legacy backup Snapshot Schedule. You can't enable legacy backups if you have an existing cluster in the project with Cloud Backups enabled. The default value is false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector | object | Optional | Configuration of BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for The BI Connector is a powerful tool which provides users
SQL-based access to their MongoDB databases. As a result, the
BI Connector performs operations which may be CPU and memory
intensive. Given the limited hardware resources on | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector.enabled | boolean | Optional | Flag that indicates whether or not BI Connector for Atlas is enabled on the cluster.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector.readPreference | string | Optional | Source from which the BI Connector for Atlas reads data. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. Tip See Also:
Note To set the readPreference value to "analytics", the cluster must have at least one analytics node. If the readPreference value is "analytics", you cannot remove all analytics nodes from the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clusterType | string | Conditional | Type of the cluster that you want to create. Note When should you use clusterType?
Atlas accepts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diskSizeGB | number | Conditional | Capacity, in gigabytes, of the host's root volume. Increase this
number to add capacity, up to a maximum possible value of
Note When should you use diskSizeGB? This setting:
The minimum disk size for dedicated clusters is 10 GB for AWS and GCP . If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. Important Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. Tip See Also: Note The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
encryptionAtRestProvider | string | Optional | Cloud service provider that offers Encryption at Rest. Specify AWS to enable Encryption at Rest using the Atlas project AWS Key Management System settings. The cluster must meet the following requirements:
You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
labels | array of objects | Optional | Collection of key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoDBMajorVersion | string | Optional | Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
You must set this value to 4.4 if "providerSettings.instanceSizeName" : "M2" or "M5". Note MongoDB 4.4 on Shared Tier Clusters You can deploy MongoDB 4.4 in Atlas free and shared-tier
clusters ( Atlas always deploys the cluster with the latest stable release of the specified version. You can upgrade to a newer version of MongoDB when you modify a cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | Required | Name of the cluster as it appears in Atlas. After Atlas creates the cluster, you can't change its name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numShards | number | Conditional | Positive integer that specifies the number of shards to deploy for a sharded cluster. Important If you use the replicationSpecs parameter, you must set numShards. Atlas accepts 1 through 50, inclusive. The default value is 1.
Note A sharded cluster with a single shard is not recommended for production environments. Single-shard sharded clusters do not provide the same high availability and horizontal scaling benefits as configurations with multiple shards. Tip See Also: Note Don't include in the request body for Global Clusters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pitEnabled | boolean | Optional | Flag that indicates the cluster uses continuous cloud backups.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerBackupEnabled | boolean | Optional | Applicable only for Flag that indicates if the cluster uses Cloud Backups for backups.
You cannot enable Cloud Backups if you have an existing cluster in the project with Legacy Backups enabled. Important You must set this value to true for NVMe clusters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings | object | Required | Configuration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling | object | Conditional | Range of instance sizes to which your cluster can scale. Important You can't specify the providerSettings.autoScaling object if "autoScaling.compute.enabled" : false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute | object | Conditional | Range of instance sizes to which your cluster can scale. Atlas requires this parameter if "autoScaling.compute.enabled" : true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute.minInstanceSize | string | Conditional | Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if "autoScaling.compute.scaleDownEnabled" : true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute.maxInstanceSize | string | Conditional | Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if "autoScaling.compute.enabled" : true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.backingProviderName | string | Conditional | Cloud service provider on which the host for a multi-tenant cluster is provisioned. This setting only works when "providerSetting.providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5. Atlas accepts the following values: Atlas accepts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.diskIOPS | number | Conditional | Disk IOPS setting for AWS storage. Set only if you selected AWS as your cloud service provider. Maximum input/output operations per second (IOPS) the system can
perform. The possible values depend on the selected
This setting requires that To view the possible range of IOPS values for the selected instance size and storage capacity:
You can see the available IOPS range by checking the Provision IOPS box. Note If you set the The default value for Changing this value affects the cost of running the cluster as described in the billing documentation. Atlas enforces the following minimum ratios for given cluster tiers. This keeps cluster performance consistent with large datasets.
Example To support 3 TB (or 3,072 GB) of disk capacity, select a cluster
tier with a minimum of 32 GB of RAM. This would be | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.diskTypeName | string | Conditional | Type of disk if you selected Azure as your cloud service provider. Disk type of the server's root volume for Azure instances. If
omitted, Atlas uses the default disk type for the selected
The following table lists the possible values for this field, and their corresponding storage size.
1 Default for 2 Default for 3 Default for | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.encryptEBSVolume | boolean | Conditional | Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note This setting is always enabled for clusters with local NVMe SSDs. The default value is true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.instanceSizeName | string | Required | Atlas provides different cluster tiers, each with a default storage capacity and RAM size. The cluster you select is used for all the data-bearing hosts in your cluster tier. Tip See Also: Important If you are deploying a Global Cluster, you must choose a cluster tier of M30 or larger.
1 Unavailable in the AP_SOUTHEAST_2 region. 2 Availability limited to the following regions:
Atlas supports the following cluster tiers.
Atlas supports deploying Note Cluster Tier Naming Conventions Cluster tier names that are:
Important
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.providerName | string | Required | Cloud service provider on which Atlas provisions the hosts.
Important
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.regionName | string | Conditional | Note Required if replicationSpecs array is empty If you haven't set values in the replicationSpecs array, you must set this parameter. Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Don't specify this parameter when creating a multi-region cluster using the replicationSpec object or a Global Cluster with the replicationSpecs array. During deployment of an For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections. Important Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC . Select your cloud service provider's tab for example cluster region names:
For a complete list of supported AWS regions, see Amazon Web Services (AWS). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.volumeType | string | Conditional | Disk IOPS setting for AWS storage. Set only if you selected AWS as your cloud service provider. Possible values are:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationFactor | number | Optional | Deprecated.
Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. Atlas accepts 3, 5, or 7. The default value is 3. Don't specify this parameter when creating a multi-region cluster using the replicationSpec object. If your cluster is a sharded cluster, each shard is a replica set with the specified replication factor. Atlas ignores this value if you pass the replicationSpec object. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec | object | Optional | Deprecated.
Configuration of each region in a multi-region cluster. Each element in this object represents a region where Atlas deploys your cluster. For single-region clusters, you can either specify the providerSettings.regionName and replicationFactor, or you can use the replicationSpec object to define a single region. For multi-region clusters, omit the providerSettings.regionName parameter. For Global Clusters, specify the replicationSpecs parameter rather than a replicationSpec parameter. Important If you use replicationSpec, you must specify a minimum of one replicationSpec.<region> object. Use the replicationSpecs parameter to create a Global Cluster. Note You cannot specify both the replicationSpec and replicationSpecs parameters in the same request body. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region> | object | Conditional | Important Use replicationSpecs[n].<region> replicationSpec.<region> is deprecated. Use replicationSpecs[n].<region>. Physical location of the region. Replace <region> with the name 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. Important If you use replicationSpec, you must specify a minimum of one replicationSpec.<region> object. Select your cloud service provider's tab for example cluster region names:
For a complete list of supported AWS regions, see Amazon Web Services (AWS). For each <region> object, you must specify the analyticsNodes, electableNodes, priority, and readOnlyNodes parameters. Tip See Also: During deployment of an For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections. Important Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.analyticsNodes | number | Optional | Important Use replicationSpecs[n].<region>.analyticsNodes replicationSpec.<region>.analyticsNodes is deprecated. Use replicationSpecs[n].<region>.analyticsNodes. The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.electableNodes | number | Optional | Important Use replicationSpecs[n].<region>.electableNodes replicationSpec.<region>.electableNodes is deprecated. Use replicationSpecs[n].<region>.electableNodes. Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. The total number of electableNodes across all replicationSpec.<region> object must be 3, 5, or 7. Specify 0 if you do not want any electable nodes in the region. You cannot create electable nodes if the replicationSpec.<region>.priority is 0. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.priority | number | Optional | Important Use replicationSpecs[n].<region>.priority replicationSpec.<region>.priority is deprecated. Use replicationSpecs[n].<region>.priority. Election priority of the region. For regions with only replicationSpec.<region>.readOnlyNodes, set this value to 0. For regions where replicationSpec.<region>.electableNodes is at least 1, each replicationSpec.<region> must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster. Example If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.readOnlyNodes | number | Optional | Important Use replicationSpecs[n].<region>.readOnlyNodes replicationSpec.<region>.readOnlyNodes is deprecated. Use replicationSpecs[n].<region>.readOnlyNodes. Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs | array of objects | Conditional | Configuration for cluster regions. Note When should you use replicationSpecs?
You must specify all parameters in replicationSpecs object array. Note What parameters depend on replicationSpecs? If you set replicationSpecs, you must:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].numShards | number | Required | Number of shards to deploy in each specified zone. The default value is 1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig | object | Optional | Configuration for a 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. Important If you use replicationSpecs, you must specify a minimum of one replicationSpecs[n].regionsConfig.<region> string. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region> | object | Required | Physical location of the region. Replace <region> with the name 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. Select your cloud service provider's tab for example cluster region names:
For a complete list of supported AWS regions, see Amazon Web Services (AWS). For each <region> object, you must specify the analyticsNodes, electableNodes, priority, and readOnlyNodes parameters. Tip See Also: During deployment of an For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections. Important Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.analyticsNodes | number | Optional | The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.If you do not specify this option, no analytics nodes are deployed to the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.electableNodes | number | Optional | Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. The total number of electableNodes across all replicationSpecs[n].regionsConfig.<region> object must be 3, 5, or 7. Specify 0 if you do not want any electable nodes in the region. You cannot create electable nodes if the replicationSpecs[n].regionsConfig.<region>.priority is 0. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.priority | number | Optional | Election priority of the region. For regions with only replicationSpecs[n].regionsConfig.<region>.readOnlyNodes, set this value to 0. For regions where replicationSpecs[n].regionsConfig.<region>.electableNodes is at least 1, each replicationSpecs[n].regionsConfig.<region> must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster. Example If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.readOnlyNodes | number | Optional | Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].zoneName | string | Optional | Name for the zone in a Global Cluster. Don't provide this value if clusterType is not GEOSHARDED. |
Response Elements¶
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
autoScaling | object | Collection of settings that configures auto-scaling information for the cluster. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.autoIndexingEnabled | boolean | Flag that indicates whether autopilot mode for Performance Advisor is enabled. The default is false. Important Autopilot mode is only available if you are enrolled in the Auto Pilot Early Access program. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute | object | Collection of settings that configure how a cluster might scale its cluster tier and whether the cluster can scale down. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute.enabled | boolean | Flag that indicates whether cluster tier auto-scaling is enabled. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.compute.scaleDownEnabled | boolean | Flag that indicates whether the cluster tier can scale down. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoScaling.diskGBEnabled | boolean | Flag that indicates whether disk auto-scaling is enabled. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backupEnabled | boolean | Flag that indicates whether legacy backup has been enabled. Important Clusters running MongoDB This change doesn't affect existing Atlas clusters that use legacy backups. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector | object | Collection of settings that configure a BI Connector for Atlas for the cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for The BI Connector is a powerful tool which provides users
SQL-based access to their MongoDB databases. As a result, the
BI Connector performs operations which may be CPU and memory
intensive. Given the limited hardware resources on | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector.enabled | boolean | Flag that indicates whether Atlas enabled the BI Connector for Atlas for this cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
biConnector.readPreference | string | Source from which the BI Connector for Atlas reads data.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clusterType | string | Type of the cluster:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings | object | Set of connection strings that your applications use to connect to this cluster. Use the parameters in this object to connect your applications to this cluster. Tip See Also: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint | array of objects | Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].connectionString | string | Private-endpoint-aware mongodb://connection string for this private endpoint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].endpoints | array of objects | Private endpoint through which you connect to Atlas when you use connectionStrings.privateEndpoint[n].connectionString or connectionStrings.privateEndpoint[n].srvConnectionString. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].endpoints[n].endpointId | string | Unique identifier of the private endpoint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].endpoints[n].providerName | string | Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].endpoints[n].region | string | Region to which you deployed the private endpoint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].srvConnectionString | string | Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:
Use this URI format if your driver supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateEndpoint[n].type | string | Type of MongoDB process that you connect to with the connection strings. Atlas returns:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.standard | string | Public mongodb:// connection string for this cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.standardSrv | string | Public mongodb+srv:// connection string for this cluster. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.private | string | Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster. Note For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.privateSrv | string | Network-peering-endpoint-aware mongodb+srv:// connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:
Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. Tip See Also: Note For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.awsPrivateLink | object | Important This field is deprecated. Use connectionStrings.privateEndpoint[n].connectionString instead. Note Atlas returns this parameter only if:
Private-endpoint-aware mongodb://connection strings for each AWS PrivateLink private endpoint. Atlas returns this parameter only if you deployed a AWS PrivateLink private endpoint to the same regions as all of this cluster's nodes. In this object:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectionStrings.awsPrivateLinkSrv | object | Important This field is deprecated. Use connectionStrings.privateEndpoint[n].srvConnectionString instead. Note Atlas returns this parameter only if:
Private-endpoint-aware mongodb+srv:// connection strings for each AWS PrivateLink private endpoint. In this object:
The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:
Use this URI format if your driver supports it. If it doesn't, use connectionStrings.awsPrivateLink. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string | Timestamp in ISO 8601 date and time format in UTC when Atlas created the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diskSizeGB | number | Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive integer. Note When should you use diskSizeGB? This setting:
The minimum disk size for dedicated clusters is 10 GB for AWS and GCP , and 32 GB for Azure . If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. Important Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. Tip See Also: Note The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
encryptionAtRestProvider | string | Cloud service provider that offers Encryption at Rest. Tip | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
groupId | string | Unique identifier of the project to which the cluster belongs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Unique identifier of the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
labels | array of documents | Collection of key-value pairs that tag and categorize the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoDBVersion | string | Version of MongoDB the cluster runs, in <major version>.<minor version> format. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoDBMajorVersion | string | Major version of MongoDB the cluster runs:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoURI | string | Base connection string for the cluster. Atlas only displays this parameter after the cluster is operational, not while it builds the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoURIUpdated | string | Timestamp in ISO 8601 date and time format in UTC when the connection string was last updated. The connection string changes if you update any of the other values. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mongoURIWithOptions | string | connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster. To review the connection string format, see the connection string format documentation. To add database users to a Atlas project, see Configure Database Users. Atlas only displays this parameter after the cluster is operational, not while it builds the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | Name of the cluster as it appears in Atlas. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numShards | number | Positive integer that specifies the number of shards for a sharded cluster. If this is set to 1, the cluster is a replica set. If this is set to 2 or higher, the cluster is a sharded cluster with the number of shards specified. Tip See Also: Atlas might return values between 1 and 50. Note Atlas doesn't return this value in the response body for Global Clusters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paused | boolean | Flag that indicates whether the cluster is paused. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pitEnabled | boolean | Flag that indicates if the cluster uses Continuous Cloud Backup backups. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerBackupEnabled | boolean | Applicable only for Flag that indicates if the cluster uses Cloud Backups for backups. If true, the cluster uses Cloud Backups for backups. If providerBackupEnabled and backupEnabled are false, the cluster does not use Atlas backups. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings | object | Configuration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling | object | Range of instance sizes to which your cluster can scale. Important You can't specify the providerSettings.autoScaling object if "autoScaling.compute.enabled" : false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute | object | Range of instance sizes to which your cluster can scale. Atlas requires this parameter if "autoScaling.compute.enabled" : true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute.minInstanceSize | string | Minimum instance size to which your cluster can automatically scale. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.autoScaling.compute.maxInstanceSize | string | Maximum instance size to which your cluster can automatically scale. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.backingProviderName | string | Cloud service provider on which the multi-tenant host is provisioned. Atlas returns this parameter only if "providerSettings.providerName" : "TENANT". Atlas can return:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.providerName | string | Cloud service provider on which Atlas provisioned the hosts. Atlas can return:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.regionName | string | Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region name values, refer to the the cloud provider reference pages: For multi-region clusters, see replicationSpec.<region>. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.diskIOPS | number | Maximum IOPS the system can perform. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.diskTypeName | string | Disk type of the host's root volume for Azure instances. The following table lists the possible values for this parameter, and their corresponding storage size.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.encryptEBSVolume | boolean | Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerSettings.instanceSizeName | string | Name of the cluster tier used for the Atlas cluster. Atlas supports the following cluster tiers.
Atlas supports deploying Note Cluster Tier Naming Conventions Cluster tier names that are:
1 Unavailable in the AP_SOUTHEAST_2 region. 2 Availability limited to the following regions:
Important
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationFactor | number | Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. For multi-region clusters, add the total number of replicationSpec.<region>.electableNodes to calculate the replication factor of the cluster. If your cluster is a sharded cluster, each shard is a replica set with the specified replication factor. Atlas may return 3, 5, or 7. Tip See Also: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec | object | Configuration of each region in the cluster. Each element in this object represents a region where Atlas deploys your cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region> | object | Physical location of the region. The <region> string corresponds to a region where Atlas deploys your cluster. 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 | Number of analytics nodes in the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.electableNodes | number | Number of electable nodes in the region. Electable nodes can become the primary and can facilitate local reads. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.priority | number | Election priority of the region. The highest possible priority is 7, which identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. The lowest possible priority is 0, which identifies a read-only region. You can have any number of priority 0 read only regions. Priorities 1 through 7 are exclusive: only one region per cluster can be assigned a given priority. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpec.<region>.readOnlyNodes | number | Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs | array | Configuration for each zone in a Global Cluster. Each object in this array represents a zone where Atlas deploys nodes for your Global Cluster. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].id | string | Unique identifier of the replication object. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].zoneName | string | Name for the zone. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].numShards | number | Number of shards to deploy in the specified zone. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig | object | 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.<region>.analyticsNodes | number | The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.If you do not specify this option, no analytics nodes are deployed to the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.electableNodes | number | Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.readOnlyNodes | number | Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].regionsConfig.<region>.priority | number | Election priority of the region. If you have regions with only read-only nodes, set this value to 0. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicationSpecs[n].zoneName | string | Name for the zone in a Global Cluster. Do not provide this value if clusterType is not GEOSHARDED. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
srvAddress | string | Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS . The mongoURI parameter lists additional options. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stateName | string | Current state of the cluster. The possible states are:
|
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Content-Type: application/json" \ 3 --include \ 4 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters?pretty=true" \ 5 --data ' 6 { 7 "name": "SingleRegionCluster", 8 "diskSizeGB": 100, 9 "numShards": 1, 10 "providerSettings": { 11 "providerName": "AWS", 12 "diskIOPS": 300, 13 "instanceSizeName": "M40", 14 "regionName": "US_EAST_1" 15 }, 16 "clusterType" : "REPLICASET", 17 "replicationFactor": 3, 18 "replicationSpecs": [{ 19 "numShards": 1, 20 "regionsConfig": { 21 "US_EAST_1": { 22 "analyticsNodes": 0, 23 "electableNodes": 3, 24 "priority": 7, 25 "readOnlyNodes": 0 26 } 27 }, 28 "zoneName": "Zone 1" 29 }], 30 "backupEnabled": false, 31 "providerBackupEnabled" : true, 32 "autoScaling": { 33 "diskGBEnabled": true 34 } 35 }'
Example Response¶
Response Header¶
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
HTTP/1.1 201 Created Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
1 { 2 "autoScaling":{ 3 "compute":{ 4 "enabled":false, 5 "scaleDownEnabled":false 6 }, 7 "diskGBEnabled":true 8 }, 9 "backupEnabled":false, 10 "biConnector":{ 11 "enabled":false, 12 "readPreference":"secondary" 13 }, 14 "clusterType":"REPLICASET", 15 "connectionStrings":{ 16 "privateEndpoint":[ 17 { 18 "connectionString":"mongodb://pl-0-us-east-1.uzgh6.mongodb.net:1024,pl-0-us-east-1.uzgh6.mongodb.net:1025,pl-0-us-east-1.uzgh6.mongodb.net:1026/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0", 19 "endpoints":[ 20 { 21 "endpointId":"vpce-0c86b555d9a233152", 22 "providerName":"AWS", 23 "region":"US_EAST_1" 24 } 25 ], 26 "srvConnectionString":"mongodb+srv://cluster1-pl-0.uzgh6.mongodb.net", 27 "type":"MONGOD" 28 } 29 ], 30 "standardSrv":"mongodb+srv://cluster1.uzgh6.mongodb.net", 31 "awsPrivateLink":{ 32 "vpce-0c86b555d9a233152":"mongodb://pl-0-us-east-1.uzgh6.mongodb.net:1024,pl-0-us-east-1.uzgh6.mongodb.net:1025,pl-0-us-east-1.uzgh6.mongodb.net:1026/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0" 33 }, 34 "awsPrivateLinkSrv":{ 35 "vpce-0c86b555d9a233152":"mongodb+srv://cluster1-pl-0.uzgh6.mongodb.net" 36 }, 37 "standard":"mongodb://cluster1-shard-00-00.uzgh6.mongodb.net:27017,cluster1-shard-00-01.uzgh6.mongodb.net:27017,cluster1-shard-00-02.uzgh6.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0" 38 }, 39 "diskSizeGB":100.0, 40 "encryptionAtRestProvider":"NONE", 41 "groupId":"{GROUP-ID}", 42 "id":"{CLUSTER-ID}", 43 "labels":[ 44 45 ], 46 "mongoDBMajorVersion":"4.0", 47 "mongoDBVersion":"4.0.13", 48 "mongoURIUpdated":"2019-12-11T17:34:08Z", 49 "name":"SingleRegionCluster", 50 "numShards":1, 51 "paused":false, 52 "pitEnabled":false, 53 "providerBackupEnabled":true, 54 "providerSettings":{ 55 "providerName":"AWS", 56 "autoScaling":{ 57 "compute":{ 58 "maxInstanceSize":null, 59 "minInstanceSize":null 60 } 61 }, 62 "diskIOPS":300, 63 "encryptEBSVolume":true, 64 "instanceSizeName":"M40", 65 "regionName":"US_EAST_1", 66 "volumeType":"STANDARD" 67 }, 68 "replicationFactor":3, 69 "replicationSpec":{ 70 "US_EAST_1":{ 71 "analyticsNodes":0, 72 "electableNodes":3, 73 "priority":7, 74 "readOnlyNodes":0 75 } 76 }, 77 "replicationSpecs":[ 78 { 79 "id":"{REPLICA-ID}", 80 "numShards":1, 81 "regionsConfig":{ 82 "US_EAST_1":{ 83 "analyticsNodes":0, 84 "electableNodes":3, 85 "priority":7, 86 "readOnlyNodes":0 87 } 88 }, 89 "zoneName":"Zone 1" 90 } 91 ], 92 "stateName":"IDLE", 93 "links":[] 94 }