Managed Service for MongoDB API, gRPC: ClusterService.EnableSharding
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
{
"clusterId": "string",
"mongocfg": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"mongos": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": "bool",
"type": "Type",
"shardName": "string",
"hidden": "google.protobuf.BoolValue",
"secondaryDelaySecs": "google.protobuf.Int64Value",
"priority": "google.protobuf.DoubleValue",
"tags": "string"
}
],
"mongoinfra": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
}
}
Field |
Description |
clusterId |
string Required field. ID of the MongoDB cluster to enable sharding for. |
mongocfg |
mongocfg specification for sharding. |
mongos |
mongos specification for sharding. |
hostSpecs[] |
Configurations for mongos and mongocfg hosts. |
mongoinfra |
mongos specification for sharding. |
MongoCfg
Field |
Description |
resources |
Required field. Resources for mongocfg hosts. |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
Mongos
Field |
Description |
resources |
Required field. Resources for mongos hosts. |
HostSpec
Field |
Description |
zoneId |
string ID of the availability zone where the host resides. |
subnetId |
string ID of the subnet that the host should belong to. This subnet should be a part |
assignPublicIp |
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 Possible values:
|
type |
enum Type Type of the host to be deployed.
|
shardName |
string Name of the shard that the host belongs to. |
hidden |
Is host hidden in replSet |
secondaryDelaySecs |
The number of seconds "behind" the primary that this replica set member should "lag" |
priority |
Priority of host for the election in replSet |
tags |
string Host tags |
MongoInfra
Field |
Description |
resources |
Required field. Resources for mongoinfra (mongos+mongocfg) hosts. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "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. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
EnableClusterShardingMetadata
Field |
Description |
clusterId |
string ID of the MongoDB cluster that sharding is being enabled for. |