Managed Service for Redis API, REST: Cluster.addShard
Creates a new shard.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}/shards
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Redis cluster to create a shard in. To get the cluster ID use a list request. The maximum string length in characters is 50. |
Body parameters
{
"shardName": "string",
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"shardName": "string",
"replicaPriority": "integer",
"assignPublicIp": true
}
]
}
Field | Description |
---|---|
shardName | string Required. Name of the shard. The name must be unique within the cluster. The maximum string length in characters is 63. Value must match the regular expression |
hostSpecs[] | object Required. Configurations for Redis hosts that should be created with the shard. Must contain at least one element. 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. |
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 ID of the network is set in the field Cluster.networkId. |
hostSpecs[]. shardName |
string ID of the Redis shard the host belongs to. To get the shard ID use a listShards request. The maximum string length in characters is 63. Value must match the regular expression |
hostSpecs[]. replicaPriority |
integer (int64) A replica with a low priority number is considered better for promotion. A replica with priority of 0 will never be selected by Redis Sentinel for promotion. Works only for non-sharded clusters. Default value is 100. |
hostSpecs[]. assignPublicIp |
boolean (boolean) Whether the host should get a public IP address on creation. Possible values:
|
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
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 |
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. |