Method enableSharding

Статья создана

Yandex.Cloud

улучшена

amatol

HTTP request
Path parameters
Body parameters
Response

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

Parameter	Description
clusterId	Required. ID of the MongoDB cluster to enable sharding for. The maximum string length in characters is 50.

Body parameters

{
  "mongocfg": {
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    }
  },
  "mongos": {
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    }
  },
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ],
  "mongoinfra": {
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    }
  }
}

Field	Description
mongocfg	object mongocfg specification for sharding.
mongocfg. resources	object Required. Resources for mongocfg hosts.
mongocfg. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
mongocfg. resources. diskSize	string (int64) Volume of the storage available to a host, in bytes.
mongocfg. resources. diskTypeId	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	object mongos specification for sharding.
mongos. resources	object Required. Resources for mongos hosts.
mongos. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
mongos. resources. diskSize	string (int64) Volume of the storage available to a host, in bytes.
mongos. resources. diskTypeId	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.
hostSpecs[]	object Required. Configurations for mongos and mongocfg hosts. Must contain at least one element.
hostSpecs[]. zoneId	string ID of the availability zone where the host resides. To get a list of available zones, use the list request. The maximum string length in characters is 50.
hostSpecs[]. subnetId	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.networkId field. The maximum string length in characters is 50.
hostSpecs[]. assignPublicIp	boolean (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 a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.
hostSpecs[]. type	string Type of the host to be deployed. MONGOD: A mongod host. MONGOS: A mongos host. MONGOCFG: A mongocfg host. MONGOINFRA: A mongoinfra (mongos+mongocfg) host.
hostSpecs[]. shardName	string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
mongoinfra	object mongos specification for sharding.
mongoinfra. resources	object Required. Resources for mongoinfra (mongos+mongocfg) hosts.
mongoinfra. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
mongoinfra. resources. diskSize	string (int64) Volume of the storage available to a host, in bytes.
mongoinfra. resources. diskTypeId	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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "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 text format.
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 text format.
done	boolean (boolean) 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	object 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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` 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.

Method enableSharding

HTTP request

Path parameters

Body parameters

Response

Была ли статья полезна?