MOmongodb
Global Clusters

Create One Managed Namespace in One Global Cluster

Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name.

post/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

clusterNamestring required

Human-readable label that identifies this cluster.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. 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. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

collectionstring required

Human-readable label of the collection to manage for this Global Cluster.

customShardKeystring required

Database parameter used to divide the collection into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.

dbstring required

Human-readable label of the database to manage for this Global Cluster.

isCustomShardKeyHashedboolean

Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to false, MongoDB Cloud uses ranged sharding.

isShardKeyUniqueboolean

Flag that indicates whether someone hashed the custom shard key. If this parameter returns false, this cluster uses ranged sharding.

numInitialChunksinteger

Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key.

presplitHashedZonesboolean

Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.