Yandex Cloud
КейсыДокументация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Managed Service for Valkey™
  • Начало работы
  • Управление доступом
  • Инспекции и рекомендации
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • Move
        • Backup
        • Restore
        • RescheduleMaintenance
        • StartFailover
        • ListLogs
        • StreamLogs
        • ListOperations
        • ListBackups
        • ListHosts
        • AddHosts
        • DeleteHosts
        • UpdateHosts
        • GetShard
        • ListShards
        • AddShard
        • DeleteShard
        • Rebalance
        • EnableSharding
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы

В этой статье:

  • gRPC request
  • AddClusterShardRequest
  • HostSpec
  • operation.Operation
  1. Справочник API
  2. gRPC (англ.)
  3. Cluster
  4. AddShard

Managed Service for Redis API, gRPC: ClusterService.AddShard

Статья создана
Yandex Cloud
Обновлена 7 октября 2026 г.
Открыть в Markdown
  • gRPC request
  • AddClusterShardRequest
  • HostSpec
  • operation.Operation

Creates a new shard.

gRPC requestgRPC request

rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

AddClusterShardRequestAddClusterShardRequest

{
  "cluster_id": "string",
  "shard_name": "string",
  "host_specs": [
    {
      "zone_id": "string",
      "subnet_id": "string",
      "shard_name": "string",
      "replica_priority": "google.protobuf.Int64Value",
      "assign_public_ip": "bool"
    }
  ]
}

Field

Description

cluster_id

string

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

The maximum string length in characters is 50.

shard_name

string

Required field. 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 [a-zA-Z0-9_-]*.

host_specs[]

HostSpec

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

The number of elements must be greater than 0.

HostSpecHostSpec

Field

Description

zone_id

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.

subnet_id

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.network_id.

shard_name

string

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

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

replica_priority

google.protobuf.Int64Value

Priority of the host as a candidate for promotion to master: the higher the value,
the more preferred the host is. A host with priority 0 is promoted only if there are
no other suitable candidates. The priority is ignored if the host requires a full
resynchronization: in that case the host with the smallest replication lag is promoted.
Works only for non-sharded clusters. Default value is 100.

assign_public_ip

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.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

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

google.protobuf.Any

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

google.protobuf.Any

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.

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

Предыдущая
ListShards
Следующая
DeleteShard
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»