Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Managed Service for MongoDB API, gRPC: ClusterService.EnableSharding

Written by
Updated at December 17, 2024

Enables sharding for the cluster:
creates 3 mongoinfra (or 3 mongocfg and 2 mongos) hosts
that would support adding and using shards in the cluster.

gRPC request

rpc EnableSharding (EnableClusterShardingRequest) returns (operation.Operation)

EnableClusterShardingRequest

{
  "cluster_id": "string",
  "mongocfg": {
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    }
  },
  "mongos": {
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    }
  },
  "host_specs": [
    {
      "zone_id": "string",
      "subnet_id": "string",
      "assign_public_ip": "bool",
      "type": "Type",
      "shard_name": "string",
      "hidden": "google.protobuf.BoolValue",
      "secondary_delay_secs": "google.protobuf.Int64Value",
      "priority": "google.protobuf.DoubleValue",
      "tags": "map<string, string>"
    }
  ],
  "mongoinfra": {
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    }
  }
}

Field

Description

cluster_id

string

Required field. ID of the MongoDB cluster to enable sharding for.

mongocfg

MongoCfg

mongocfg specification for sharding.

mongos

Mongos

mongos specification for sharding.

host_specs[]

HostSpec

Configurations for mongos and mongocfg hosts.

mongoinfra

MongoInfra

mongos specification for sharding.

MongoCfg

Field

Description

resources

Resources

Required field. Resources for mongocfg hosts.

Resources

Field

Description

resource_preset_id

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

disk_size

int64

Volume of the storage available to a host, in bytes.

disk_type_id

string

Type of the storage environment for the host.
Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

Mongos

Field

Description

resources

Resources

Required field. Resources for mongos hosts.

HostSpec

Field

Description

zone_id

string

ID of the availability zone where the host resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnet_id

string

ID of the subnet that the host should belong to. This subnet should be a part
of the network that the cluster belongs to.
The network ID is set in the Cluster.network_id field.

assign_public_ip

bool

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign
a public IP to a host without one, recreate the host with assign_public_ip set as needed.

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.

type

enum Type

Type of the host to be deployed.

  • TYPE_UNSPECIFIED: Type of the host is unspecified. Default value.
  • MONGOD: A mongod host.
  • MONGOS: A mongos host.
  • MONGOCFG: A mongocfg host.
  • MONGOINFRA: A mongoinfra (mongos+mongocfg) host.

shard_name

string

Name of the shard that the host belongs to.

hidden

google.protobuf.BoolValue

Is host hidden in replSet

secondary_delay_secs

google.protobuf.Int64Value

The number of seconds "behind" the primary that this replica set member should "lag"

priority

google.protobuf.DoubleValue

Priority of host for the election in replSet

tags

object (map<string, string>)

Host tags

MongoInfra

Field

Description

resources

Resources

Required field. Resources for mongoinfra (mongos+mongocfg) hosts.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

EnableClusterShardingMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

EnableClusterShardingMetadata

Field

Description

cluster_id

string

ID of the MongoDB cluster that sharding is being enabled for.
Previous
UpdateHosts
Next
GetShard