Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for Redis API, gRPC: ClusterService.AddShard

Written by
Updated at October 17, 2024

Creates a new shard.

gRPC request

rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

AddClusterShardRequest

{
  "clusterId": "string",
  "shardName": "string",
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "shardName": "string",
      "replicaPriority": "google.protobuf.Int64Value",
      "assignPublicIp": "bool"
    }
  ]
}

Field

Description

clusterId

string

Required field. ID of the Redis cluster to create a shard in.
To get the cluster ID use a ClusterService.List request.

shardName

string

Required field. Name of the shard.
The name must be unique within the cluster.

hostSpecs[]

HostSpec

Configurations for Redis hosts that should be created with the shard.
Must contain at least one element.

HostSpec

Field

Description

zoneId

string

ID of the availability zone where the host resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

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.

shardName

string

ID of the Redis shard the host belongs to.
To get the shard ID use a ClusterService.ListShards request.

replicaPriority

google.protobuf.Int64Value

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.

assignPublicIp

bool

Whether the host should get a public IP address on creation.

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "shardName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "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

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

AddClusterShardMetadata

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

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Shard

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.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

AddClusterShardMetadata

Field

Description

clusterId

string

ID of the Redis cluster that a shard is being added to.

shardName

string

Name of the Redis shard that is being created.

Shard

Field

Description

name

string

Name of the Redis shard. The shard name is assigned by user at creation time, and cannot be changed.
1-63 characters long.

clusterId

string

ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.
Previous
ListShards
Next
DeleteShard