Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Compute Cloud
  • Начало работы
    • Обзор
    • Создание виртуальной машины Linux
    • Создание виртуальной машины Windows
    • Создание группы виртуальных машин
  • Пошаговые инструкции
    • Все инструкции
    • Создание виртуальной машины
      • Создать ВМ Linux
      • Создать ВМ Windows
      • Создать ВМ из набора дисков
      • Создать ВМ с дисками из снимков
      • Создать ВМ из пользовательского образа
      • Создать ВМ c GPU
      • Сделать ВМ прерываемой
    • DSVM
      • Обзор
      • Создать ВМ из публичного образа DSVM
    • Группы размещения
      • Создать группу размещения
      • Удалить группу размещения
      • Создать ВМ в группе размещения
      • Добавить ВМ в группу размещения
      • Исключить ВМ из группы размещения
    • Образы с предустановленным ПО
      • Создать ВМ из публичного образа
      • Настроить ПО
      • Работа с ВМ на базе публичного образа
      • Получить список публичных образов
    • Получение информации о виртуальной машине
      • Получить информацию о ВМ
      • Получить вывод последовательного порта
    • Управление виртуальной машиной
      • Остановить и запустить ВМ
      • Сбросить пароль пользователя ВМ
      • Подключить диск к ВМ
      • Отключить диск от ВМ
      • Перенести ВМ в другую зону доступности
      • Перенести ВМ в другой каталог
      • Привязать к ВМ публичный IP-адрес
      • Отвязать от ВМ публичный IP-адрес
      • Сделать публичный IP-адрес ВМ статическим
      • Изменить ВМ
      • Изменить вычислительные ресурсы ВМ
      • Удалить ВМ
    • Работа на виртуальной машине
      • Подключиться к ВМ по SSH
      • Подключиться к ВМ по RDP
      • Подключиться к ВМ через PowerShell
      • Работа с Yandex Cloud изнутри ВМ
      • Установить NVIDIA-драйверы
      • Восстановить доступ к ВМ
    • Управление агентом для сброса паролей
      • Проверить работу агента
      • Установить агент
      • Удалить агент
    • Создание диска
      • Создать пустой диcк
      • Создать пустой диск с блоком большого размера
      • Создать нереплицируемый диск
    • Управление диском
      • Создать снимок диска
      • Изменить диск
      • Перенести диск в другой каталог
      • Удалить диcк
      • Удалить снимок диска
    • Группы размещения дисков
      • Создать группу размещения дисков
      • Удалить диск из группы размещения
    • Создание образа
      • Подготовить образ диска
      • Загрузить свой образ
      • Создать образ из диска
      • Создать образ из снимка диска
      • Создать образ из другого пользовательского образа
    • Управление образом
      • Получить список образов
      • Удалить образ
    • Файловые хранилища
      • Создать файловое хранилище
      • Подключить файловое хранилище к ВМ
      • Отключить файловое хранилище от ВМ
      • Изменить файловое хранилище
      • Удалить файловое хранилище
    • Управление серийной консолью
      • Начало работы
      • Подключиться к серийной консоли по SSH
      • Подключиться к серийной консоли с помощью CLI
      • Запустить командную оболочку в Windows SAC
      • Отключить доступ к серийной консоли
    • Создание группы виртуальных машин
      • Создать группу ВМ фиксированного размера
      • Создать группу ВМ фиксированного размера с сетевым балансировщиком
      • Создать группу ВМ фиксированного размера с L7-балансировщиком
      • Создать автоматически масштабируемую группу ВМ
      • Создать группу ВМ с Container Optimized Image
      • Создать группу ВМ по YAML-спецификации
    • Получение информации о группе виртуальных машин
      • Получить список групп ВМ
      • Получить информацию о группе ВМ
      • Получить список ВМ в группе
    • Управление группой виртуальных машин
      • Изменить группу ВМ
      • Изменить группу ВМ по YAML-спецификации
      • Настроить проверку состояния приложения на ВМ
      • Обновить группу
        • Постепенное обновление
        • Обновление без простоя
      • Приостановить процессы в группе ВМ
      • Возобновить процессы в группе ВМ
      • Остановить группу ВМ
      • Запустить группу ВМ
      • Удалить группу ВМ
    • Выделенные хосты
      • Создать группу выделенных хостов
      • Создать ВМ в группе выделенных хостов
      • Создать ВМ на выделенном хосте
  • Yandex Container Solution
  • Практические руководства
    • Настройка синхронизации времени NTP
    • Работа с группой ВМ с автоматическим масштабированием
    • Автомасштабирование группы ВМ для обработки сообщений из очереди
    • Обновление группы ВМ под нагрузкой
    • Развертывание Remote Desktop Gateway
    • Передача логов с ВМ в Yandex Cloud Logging
    • Сборка образа ВМ с набором инфраструктурных инструментов с помощью Packer
  • Концепции
    • Взаимосвязь ресурсов
    • Виртуальные машины
      • Обзор
      • Платформы
      • Уровни производительности vCPU
      • Прерываемые виртуальные машины
      • Сеть на виртуальной машине
      • Программно-ускоренная сеть
      • Динамическая миграция
      • Группы размещения
      • Статусы
      • Метаданные
      • Сброс паролей на ВМ Windows
    • Графические ускорители
    • Диски и файловые хранилища
      • Обзор
      • Диски
      • Снимки дисков
      • Группы размещения нереплицируемых дисков
      • Файловые хранилища
      • Операции чтения и записи
    • Образы
    • Группы виртуальных машин
      • Обзор
      • Доступ
      • YAML-спецификация
      • Шаблон виртуальной машины
      • Переменные в шаблоне виртуальной машины
      • Политики
        • Обзор
        • Политика распределения
        • Политика развертывания
        • Политика масштабирования
      • Типы масштабирования
      • Автоматическое восстановление
      • Обновление
        • Обзор
        • Распределение виртуальных машин по зонам
        • Алгоритм развертывания
        • Правила обновления виртуальных машин
        • Изменение дополнительных дисков в шаблоне виртуальной машины
      • Остановка группы и приостановка процессов
      • Статусы
    • Выделенный хост
    • Резервное копирование
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта до 1 мая 2019 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • DiskPlacementGroupService
      • DiskService
      • DiskTypeService
      • FilesystemService
      • HostGroupService
      • HostTypeService
      • ImageService
      • InstanceService
      • PlacementGroupService
      • SnapshotService
      • ZoneService
      • InstanceGroupService
      • OperationService
    • REST (англ.)
      • Overview
      • DiskPlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listDisks
        • listOperations
        • update
      • Disk
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • DiskType
        • Overview
        • get
        • list
      • Filesystem
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • HostGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
      • HostType
        • Overview
        • get
        • list
      • Image
        • Overview
        • create
        • delete
        • get
        • getLatestByFamily
        • list
        • listOperations
        • update
      • Instance
        • Overview
        • addOneToOneNat
        • attachDisk
        • attachFilesystem
        • create
        • delete
        • detachDisk
        • detachFilesystem
        • get
        • getSerialPortOutput
        • list
        • listOperations
        • move
        • removeOneToOneNat
        • restart
        • start
        • stop
        • update
        • updateMetadata
        • updateNetworkInterface
      • PlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listInstances
        • listOperations
        • update
      • Snapshot
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Zone
        • Overview
        • get
        • list
      • Operation
        • Overview
        • get
      • InstanceGroup
        • Overview
        • list
        • get
        • listLogRecords
        • updateFromYaml
        • updateAccessBindings
        • pauseProcesses
        • stop
        • start
        • delete
        • listInstances
        • createFromYaml
        • update
        • setAccessBindings
        • listOperations
        • create
        • listAccessBindings
        • resumeProcesses
  • Вопросы и ответы
    • Общие вопросы
    • Виртуальные машины
    • Подключение
    • Диски, снимки, образы
    • Аварийное восстановление
    • Мониторинг
    • Лицензирование
    • Все вопросы на одной странице
  1. Справочник API
  2. gRPC (англ.)
  3. HostGroupService

HostGroupService

Статья создана
Yandex Cloud
  • Calls HostGroupService
  • Get
    • GetHostGroupRequest
    • HostGroup
    • ScalePolicy
    • FixedScale
  • List
    • ListHostGroupsRequest
    • ListHostGroupsResponse
    • HostGroup
    • ScalePolicy
    • FixedScale
  • Create
    • CreateHostGroupRequest
    • ScalePolicy
    • FixedScale
    • Operation
    • CreateHostGroupMetadata
    • HostGroup
    • ScalePolicy
    • FixedScale
  • Update
    • UpdateHostGroupRequest
    • ScalePolicy
    • FixedScale
    • Operation
    • UpdateHostGroupMetadata
    • HostGroup
    • ScalePolicy
    • FixedScale
  • Delete
    • DeleteHostGroupRequest
    • Operation
    • DeleteHostGroupMetadata
  • ListOperations
    • ListHostGroupOperationsRequest
    • ListHostGroupOperationsResponse
    • Operation
  • ListInstances
    • ListHostGroupInstancesRequest
    • ListHostGroupInstancesResponse
    • Instance
    • Resources
    • AttachedDisk
    • AttachedLocalDisk
    • AttachedFilesystem
    • NetworkInterface
    • PrimaryAddress
    • OneToOneNat
    • DnsRecord
    • DnsRecord
    • SchedulingPolicy
    • NetworkSettings
    • PlacementPolicy
    • HostAffinityRule
  • ListHosts
    • ListHostGroupHostsRequest
    • ListHostGroupHostsResponse
    • Host

A set of methods for managing groups of dedicated hosts.

Call Description
Get Returns the specified host group.
List Retrieves the list of host groups in the specified folder.
Create Creates a host group in the specified folder.
Update Updates the specified host group.
Delete Deletes the specified host group.
ListOperations Lists operations for the specified host group.
ListInstances Lists instances that belongs to the specified host group.
ListHosts Lists hosts that belongs to the specified host group.

Calls HostGroupService

Get

Returns the specified host group.

rpc Get (GetHostGroupRequest) returns (HostGroup)

GetHostGroupRequest

Field Description
host_group_id string
Required. ID of the host group to return. To get the host group ID, use HostGroupService.List request. The maximum string length in characters is 50.

HostGroup

Field Description
id string
ID of the group.
folder_id string
ID of the folder that the group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name string
Name of the group. The name is unique within the folder.
description string
Description of the group.
labels map<string,string>
Resource labels as key:value pairs.
zone_id string
Availability zone where all dedicated hosts are allocated.
status enum Status
Status of the group.
type_id string
ID of host type. Resources provided by each host of the group.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events.
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

List

Retrieves the list of host groups in the specified folder.

rpc List (ListHostGroupsRequest) returns (ListHostGroupsResponse)

ListHostGroupsRequest

Field Description
folder_id string
Required. ID of the folder to list host groups in. To get the folder ID, use yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListHostGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListHostGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response. Currently you can use filtering only on the HostGroup.name field. The maximum string length in characters is 1000.

ListHostGroupsResponse

Field Description
host_groups[] HostGroup
Lists host groups for the specified folder.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is larger than ListHostGroupsRequest.page_size, use next_page_token as the value for the ListHostGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

HostGroup

Field Description
id string
ID of the group.
folder_id string
ID of the folder that the group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name string
Name of the group. The name is unique within the folder.
description string
Description of the group.
labels map<string,string>
Resource labels as key:value pairs.
zone_id string
Availability zone where all dedicated hosts are allocated.
status enum Status
Status of the group.
type_id string
ID of host type. Resources provided by each host of the group.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events.
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

Create

Creates a host group in the specified folder.

rpc Create (CreateHostGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateHostGroupMetadata

    Operation.response:HostGroup

CreateHostGroupRequest

Field Description
folder_id string
Required. ID of the folder to create a host group in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name string
Name of the group. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Description of the group. The maximum string length in characters is 256.
labels map<string,string>
Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.
zone_id string
Required. Availability zone where all dedicated hosts will be allocated. The maximum string length in characters is 50.
type_id string
Required. ID of host type. Resources provided by each host of the group. The maximum string length in characters is 50.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events.
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

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<CreateHostGroupMetadata>
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.
result oneof: error or 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.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<HostGroup>
if operation finished successfully.

CreateHostGroupMetadata

Field Description
host_group_id string
ID of the host group that is being created.

HostGroup

Field Description
id string
ID of the group.
folder_id string
ID of the folder that the group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name string
Name of the group. The name is unique within the folder.
description string
Description of the group.
labels map<string,string>
Resource labels as key:value pairs.
zone_id string
Availability zone where all dedicated hosts are allocated.
status enum Status
Status of the group.
type_id string
ID of host type. Resources provided by each host of the group.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events.
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

Update

Updates the specified host group.

rpc Update (UpdateHostGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateHostGroupMetadata

    Operation.response:HostGroup

UpdateHostGroupRequest

Field Description
host_group_id string
Required. ID of the host group to update. To get the host group ID, use an HostGroupService.List request. The maximum string length in characters is 50.
update_mask google.protobuf.FieldMask
Field mask that specifies which fields of the HostGroup resource are going to be updated.
name string
Name of the group. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Description of the group. The maximum string length in characters is 256.
labels map<string,string>
Resource labels as key:value pairs.
The existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

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<UpdateHostGroupMetadata>
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.
result oneof: error or 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.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<HostGroup>
if operation finished successfully.

UpdateHostGroupMetadata

Field Description
host_group_id string
ID of the host group that is being updated.

HostGroup

Field Description
id string
ID of the group.
folder_id string
ID of the folder that the group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name string
Name of the group. The name is unique within the folder.
description string
Description of the group.
labels map<string,string>
Resource labels as key:value pairs.
zone_id string
Availability zone where all dedicated hosts are allocated.
status enum Status
Status of the group.
type_id string
ID of host type. Resources provided by each host of the group.
maintenance_policy enum MaintenancePolicy
Behaviour on maintenance events.
  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scale_policy ScalePolicy
Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field Description
scale_type oneof: fixed_scale
  fixed_scale FixedScale

FixedScale

Field Description
size int64

Delete

Deletes the specified host group.

rpc Delete (DeleteHostGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteHostGroupMetadata

    Operation.response:google.protobuf.Empty

DeleteHostGroupRequest

Field Description
host_group_id string
Required. ID of the host group to delete. To get the host group ID, use HostGroupService.List request. The maximum string length in characters is 50.

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<DeleteHostGroupMetadata>
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.
result oneof: error or 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.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

DeleteHostGroupMetadata

Field Description
host_group_id string
ID of the host group that is being deleted.

ListOperations

Lists operations for the specified host group.

rpc ListOperations (ListHostGroupOperationsRequest) returns (ListHostGroupOperationsResponse)

ListHostGroupOperationsRequest

Field Description
host_group_id string
Required. ID of the host group to list operations for. To get the host group ID, use HostGroupService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListHostGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListHostGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListHostGroupOperationsResponse

Field Description
operations[] operation.Operation
List of operations for the specified host group.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is larger than ListHostGroupOperationsRequest.page_size, use the next_page_token as the value for the ListHostGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

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.
result oneof: error or 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.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  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.

ListInstances

Lists instances that belongs to the specified host group.

rpc ListInstances (ListHostGroupInstancesRequest) returns (ListHostGroupInstancesResponse)

ListHostGroupInstancesRequest

Field Description
host_group_id string
Required. ID of the host group to list instances for. To get the host group ID, use HostGroupService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListHostGroupInstancesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListHostGroupInstancesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response. Currently you can use filtering only on the Host.id field. To get the host ID, use HostGroupService.ListHosts request. The maximum string length in characters is 1000.

ListHostGroupInstancesResponse

Field Description
instances[] Instance
Lists instances for the specified host group.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is more than ListHostGroupInstancesRequest.page_size, use next_page_token as the value for the ListHostGroupInstancesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Instance

Field Description
id string
ID of the instance.
folder_id string
ID of the folder that the instance belongs to.
created_at google.protobuf.Timestamp
name string
Name of the instance. 1-63 characters long.
description string
Description of the instance. 0-256 characters long.
labels map<string,string>
Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id string
ID of the availability zone where the instance resides.
platform_id string
ID of the hardware platform configuration for the instance.
resources Resources
Computing resources of the instance such as the amount of memory and number of cores.
status enum Status
Status of the instance.
  • PROVISIONING: Instance is waiting for resources to be allocated.
  • RUNNING: Instance is running normally.
  • STOPPING: Instance is being stopped.
  • STOPPED: Instance stopped.
  • STARTING: Instance is being started.
  • RESTARTING: Instance is being restarted.
  • UPDATING: Instance is being updated.
  • ERROR: Instance encountered a problem and cannot operate.
  • CRASHED: Instance crashed and will be restarted automatically.
  • DELETING: Instance is being deleted.
metadata map<string,string>
The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys.
For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk AttachedDisk
Boot disk that is attached to the instance.
secondary_disks[] AttachedDisk
Array of secondary disks that are attached to the instance.
local_disks[] AttachedLocalDisk
Array of local disks that are attached to the instance.
filesystems[] AttachedFilesystem
Array of filesystems that are attached to the instance.
network_interfaces[] NetworkInterface
Array of network interfaces that are attached to the instance.
fqdn string
A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy SchedulingPolicy
Scheduling policy configuration.
service_account_id string
ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings NetworkSettings
Network Settings
placement_policy PlacementPolicy
Placement policy configuration.

Resources

Field Description
memory int64
The amount of memory available to the instance, specified in bytes.
cores int64
The number of cores available to the instance.
core_fraction int64
Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus int64
The number of GPUs available to the instance.

AttachedDisk

Field Description
mode enum Mode
Access mode to the Disk resource.
  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
device_name string
Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance.
This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete bool
Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id string
ID of the disk that is attached to the instance.

AttachedLocalDisk

Field Description
size int64
Size of the disk, specified in bytes.
device_name string
Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance.
This value can be used to reference the device for mounting, resizing, and so on, from within the instance.

AttachedFilesystem

Field Description
mode enum Mode
Access mode to the filesystem.
  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
device_name string
Name of the device representing the filesystem on the instance.
The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.
filesystem_id string
ID of the filesystem that is attached to the instance.

NetworkInterface

Field Description
index string
The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address string
MAC address that is assigned to the network interface.
subnet_id string
ID of the subnet.
primary_v4_address PrimaryAddress
Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address PrimaryAddress
Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet.
security_group_ids[] string
ID's of security groups attached to the interface

PrimaryAddress

Field Description
address string
An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat OneToOneNat
One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[] DnsRecord
Internal DNS configuration

OneToOneNat

Field Description
address string
An external IP address associated with this instance.
ip_version enum IpVersion
IP version for the external IP address.
  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
dns_records[] DnsRecord
External DNS configuration

DnsRecord

Field Description
fqdn string
Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id string
DNS zone id for the record (optional, if not set, some private zone is used).
ttl int64
DNS record ttl (optional, if not set, a reasonable default is used.)
ptr bool
When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field Description
fqdn string
Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id string
DNS zone id for the record (optional, if not set, some private zone is used).
ttl int64
DNS record ttl (optional, if not set, a reasonable default is used.)
ptr bool
When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field Description
preemptible bool
True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field Description
type enum Type
Network Type
  • STANDARD: Standard network.
  • SOFTWARE_ACCELERATED: Software accelerated network.
  • HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field Description
placement_group_id string
Placement group ID.
host_affinity_rules[] HostAffinityRule
List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field Description
key string
Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op enum Operator
Include or exclude action
values[] string
Affinity value or host ID or host group ID

ListHosts

Lists hosts that belongs to the specified host group.

rpc ListHosts (ListHostGroupHostsRequest) returns (ListHostGroupHostsResponse)

ListHostGroupHostsRequest

Field Description
host_group_id string
Required. ID of the host group to list hosts for. To get the host group ID, use HostGroupService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListHostGroupHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListHostGroupHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListHostGroupHostsResponse

Field Description
hosts[] Host
Lists hosts for the specified host group.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is more than ListHostGroupHostsRequest.page_size, use next_page_token as the value for the ListHostGroupHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Host

Field Description
id string
ID of the host.
status enum Status
Current status of the host. New instances are unable to start on host in DOWN status.
server_id string
ID of the physical server that the host belongs to.

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

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Calls HostGroupService
  • Get
  • GetHostGroupRequest
  • HostGroup
  • ScalePolicy
  • FixedScale
  • List
  • ListHostGroupsRequest
  • ListHostGroupsResponse
  • HostGroup
  • ScalePolicy
  • FixedScale
  • Create
  • CreateHostGroupRequest
  • ScalePolicy
  • FixedScale
  • Operation
  • CreateHostGroupMetadata
  • HostGroup
  • ScalePolicy
  • FixedScale
  • Update
  • UpdateHostGroupRequest
  • ScalePolicy
  • FixedScale
  • Operation
  • UpdateHostGroupMetadata
  • HostGroup
  • ScalePolicy
  • FixedScale
  • Delete
  • DeleteHostGroupRequest
  • Operation
  • DeleteHostGroupMetadata
  • ListOperations
  • ListHostGroupOperationsRequest
  • ListHostGroupOperationsResponse
  • Operation
  • ListInstances
  • ListHostGroupInstancesRequest
  • ListHostGroupInstancesResponse
  • Instance
  • Resources
  • AttachedDisk
  • AttachedLocalDisk
  • AttachedFilesystem
  • NetworkInterface
  • PrimaryAddress
  • OneToOneNat
  • DnsRecord
  • DnsRecord
  • SchedulingPolicy
  • NetworkSettings
  • PlacementPolicy
  • HostAffinityRule
  • ListHosts
  • ListHostGroupHostsRequest
  • ListHostGroupHostsResponse
  • Host