Yandex Cloud
Документация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex StoreDoc
RU
  • Начало работы
  • Управление доступом
  • Инспекции и рекомендации
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • Move
        • Backup
        • Restore
        • RescheduleMaintenance
        • ListLogs
        • StreamLogs
        • ListOperations
        • ListBackups
        • ListHosts
        • AddHosts
        • DeleteHosts
        • UpdateHosts
        • EnableSharding
        • GetShard
        • ListShards
        • AddShard
        • DeleteShard
        • ResetupHosts
        • RestartHosts
        • StepdownHosts
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
        • SetBalancerStatus
  • Справочник метрик
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Обучающие курсы

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

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

Managed Service for MongoDB API, gRPC: ClusterService.AddHosts

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

Creates new hosts for a cluster.

gRPC requestgRPC request

rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

AddClusterHostsRequestAddClusterHostsRequest

{
  "cluster_id": "string",
  "host_specs": [
    {
      "zone_id": "string",
      "subnet_id": "string",
      "assign_public_ip": "bool",
      "type": "Type",
      "shard_name": "string",
      "hidden": "google.protobuf.BoolValue",
      "secondary_delay_secs": "google.protobuf.Int64Value",
      "priority": "google.protobuf.DoubleValue",
      "tags": "map<string, string>",
      "votes": "google.protobuf.Int64Value"
    }
  ]
}

Field

Description

cluster_id

string

Required field. ID of the StoreDoc cluster to add hosts to.
To get the StoreDoc cluster ID use a ClusterService.List request.

The maximum string length in characters is 50.

host_specs[]

HostSpec

Configurations for StoreDoc hosts that should be added to the cluster.

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.

The maximum string length in characters is 50.

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 network ID is set in the Cluster.network_id field.

The maximum string length in characters is 50.

assign_public_ip

bool

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 assign_public_ip set as needed.
Possible values:

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

type

enum Type

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.

shard_name

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_-]*.

hidden

google.protobuf.BoolValue

Is host hidden in replSet

secondary_delay_secs

google.protobuf.Int64Value

The number of seconds "behind" the primary that this replica set member should "lag"

priority

google.protobuf.DoubleValue

Priority of host for the election in replSet

tags

object (map<string, string>)

Host tags

votes

google.protobuf.Int64Value

Votes of host for the election in replSet

Acceptable values are 0 to 1, inclusive.

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.

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

Предыдущая
ListHosts
Следующая
DeleteHosts
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»