Get Global Clusters Data

On this page

Syntax

Request Path Parameters
Request Query Parameters
Request Body Parameters
HTTP Response Elements
Example
Request
Response

Note

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.

The Atlas Administration 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 Get Started with the Atlas Administration API.

https://cloud.mongodb.com/api/atlas/v1.0

Retrieve all managed namespaces and custom zone mappings associated with a Global Cluster.

Syntax

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/globalWrites

Request Path Parameters

Path Element	Required/Optional	Description
`GROUP-ID`	Required.	The unique identifier for the project that contains the Global Cluster.
`CLUSTER-NAME`	Required.	The name of the Global Cluster.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas Administration API resources. These are all optional.

Name	Type	Necessity	Description	Default
pageNum	integer	Optional	Page number, starting with one, that Atlas returns of the total number of objects.	`1`
itemsPerPage	integer	Optional	Number of items that Atlas returns per page, up to a maximum of 500.	`100`
includeCount	boolean	Optional	Flag that indicates whether Atlas returns the totalCount parameter in the response body.	`true`
pretty	boolean	Optional	Flag that indicates whether Atlas returns the JSON response in the prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope=true` in the query. Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.	`false`

Request Body Parameters

This endpoint does not use HTTP request body parameters.

HTTP Response Elements

Name	Type	Description
`customZoneMapping`	document	A comma-separated list of all custom zone mappings defined for the Global Cluster. Atlas automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. If your Global Cluster does not have any custom zone mappings, this document is empty.
`managedNamespaces`	array of documents	Each document specifies a namespace for a Global Cluster managed by Atlas.
`managedNamespaces[n].collection`	string	The name of the collection associated with the managed namespace.
`managedNamespaces[n].customShardKey`	string	The custom shard key for the collection. Global Clusters require a compound shard key consisting of a `location` field and a user-selected second key, the custom shard key.
`managedNamespaces[n].db`	string	The name of the database containing the collection.
`managedNamespaces[n].isCustomShardKeyHashed`	boolean	Flag that specifies whether the custom shard key for the collection is hashed. Value can be one of the following: `true` - if custom shard key is hashed `false` - if custom shard key is not hashed (default) Default value is `false`. If `false`, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
`managedNamespaces[n].isShardKeyUnique`	boolean	Flag that specifies whether the underlying index enforces a unique constraint. Value can be one of the following: `true` - if shard key is unique `false` - if shard key is not unique (default)
`managedNamespaces[n].numInitialChunks`	integer	Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key. To learn more, see Global Cluster Sharding Reference. This is only available for Atlas clusters with MongoDB v4.4 and later.
`managedNamespaces[n].presplitHashedZones`	boolean	Flag that specifies whether to perform initial chunk creation and distribution for an empty or non-existing collection based on the defined zones and zone ranges for the collection. Value can be one of the following: `true` - to perform initial chunk creation and distribution `false` - to not perform initial chunk creation and distribution (default) Default value is `false`. This is only available for Atlas clusters with MongoDB v4.4 and later.

Example

Request

curl -X GET -i --digest --user "{PUBLIC-KEY}:{PRIVATE-KEY}" "https://cloud.mongodb.com/api/atlas/v1.0/groups/6c391af480eef519ea5deeb1/clusters/Cluster1/globalWrites?pretty=true"

Response

 {
   "customZoneMapping" : {
     "AF" : "5b48f5a780eef5236f689f94",
     "AL" : "5b48f5a780eef5236f689f94",
     "AU" : "5b48f5cddff5220000f7f375",
     "AU-ACT" : "5b48f5cddff5220000f7f375",
     "AU-NSW" : "5b48f5cddff5220000f7f375",
     "AU-NT" : "5b48f5cddff5220000f7f375",
     "AU-QLD" : "5b48f5cddff5220000f7f375",
     "AU-SA" : "5b48f5cddff5220000f7f375",
     "AU-TAS" : "5b48f5cddff5220000f7f375",
     "AU-VIC" : "5b48f5cddff5220000f7f375",
     "AU-WA" : "5b48f5cddff5220000f7f375",
     "DZ" : "5b48f5a780eef5236f689f94"
},
   "managedNamespaces" : [ {
     "collection" : "zips",
     "customShardKey" : "city",
     "db" : "mydata",
     "isCustomShardKeyHashed": false,
     "isShardKeyUnique": false,
     "numInitialChunks": null,
     "presplitHashedZones": false
   },{
     "collection" : "stores",
     "customShardKey" : "store_number",
     "db" : "mydata",
     "isCustomShardKeyHashed": false,
     "isShardKeyUnique": false,
     "numInitialChunks": null,
     "presplitHashedZones": false
   } ]
 }

← Global Clusters Add a Managed Namespace →