Managed Service for MongoDB API, REST: Cluster.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.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}:enableSharding
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the MongoDB cluster to enable sharding for. |
Body parameters
{
"mongocfg": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"mongos": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": "boolean",
"type": "string",
"shardName": "string",
"hidden": "boolean",
"secondaryDelaySecs": "string",
"priority": "number",
"tags": "string"
}
],
"mongoinfra": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
}
}
Field |
Description |
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 |
string (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 |
boolean 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 |
boolean Is host hidden in replSet |
secondaryDelaySecs |
string (int64) The number of seconds "behind" the primary that this replica set member should "lag" |
priority |
number (double) Priority of host for the election in replSet |
tags |
string Host tags |
MongoInfra
Field |
Description |
resources |
Required field. Resources for mongoinfra (mongos+mongocfg) hosts. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string"
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
}
// 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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean 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. |
EnableClusterShardingMetadata
Field |
Description |
clusterId |
string ID of the MongoDB cluster that sharding is being enabled for. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |