Add a Managed Namespace¶
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 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.
https://cloud.mongodb.com/api/atlas/v1.0
Add a managed namespace to a Global Cluster. For more information about managed namespaces, see Global Clusters.
Syntax¶
POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/globalWrites/managedNamespaces
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¶
The following query parameters are optional:
Query Parameter | Type | Description | Default |
---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
collection | string | The name of the collection associated with the managed namespace. |
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. |
db | string | The name of the database containing the collection. |
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. |
Example¶
Request¶
curl -X POST -i --digest --user "{PUBLIC-KEY}:{PRIVATE-KEY}" -H "Content-Type: application/json" \ "https://cloud.mongodb.com/api/atlas/v1.0/groups/6c391af480eef519ea5deeb1/clusters/Cluster1/globalWrites/managedNamespaces?pretty=true" \ --data '{ "db":"mydata", "collection":"publishers", "customShardKey":"city" }'
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" : "publishers", "customShardKey" : "city", "db" : "mydata" },{ "collection" : "stores", "customShardKey" : "store_number", "db" : "mydata" } ] }
Give Feedback