Managed Service for MongoDB API, REST: Cluster.AddShard
Creates a new shard.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/shards
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the MongoDB cluster to add a shard to. |
Body parameters
{
"shardName": "string",
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": "boolean",
"type": "string",
"shardName": "string",
"hidden": "boolean",
"secondaryDelaySecs": "string",
"priority": "number",
"tags": "string"
}
]
}
Field |
Description |
shardName |
string Required field. Name of the MongoDB shard to create. |
hostSpecs[] |
Configurations for mongod hosts to be created with the shard. |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"shardName": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"name": "string",
"clusterId": "string"
}
// 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. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
AddClusterShardMetadata
Field |
Description |
clusterId |
string ID of the MongoDB cluster that a shard is being added to. |
shardName |
string Name of the shard being added. |
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. |
Shard
Field |
Description |
name |
string Name of the shard. |
clusterId |
string ID of the cluster that the shard belongs to. |