InstanceGroupService
- Вызовы InstanceGroupService
- Get
- GetInstanceGroupRequest
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- List
- ListInstanceGroupsRequest
- ListInstanceGroupsResponse
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Create
- CreateInstanceGroupRequest
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Operation
- CreateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- CreateFromYaml
- CreateInstanceGroupFromYamlRequest
- Operation
- CreateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Update
- UpdateInstanceGroupRequest
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- LoadBalancerSpec
- TargetGroupSpec
- Operation
- UpdateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- UpdateFromYaml
- UpdateInstanceGroupFromYamlRequest
- Operation
- UpdateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Stop
- StopInstanceGroupRequest
- Operation
- StopInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Start
- StartInstanceGroupRequest
- Operation
- StartInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Delete
- ListInstances
- ListOperations
- ListLogRecords
Набор методов для управления ресурсами InstanceGroup.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс InstanceGroup. |
List | Возвращает список доступных ресурсов InstanceGroup в указанном каталоге. |
Create | Создает группу виртуальных машин в указанном каталоге. |
CreateFromYaml | Создает группу виртуальных машин в указанном каталоге из YAML-файла. |
Update | Изменяет указанную группу виртуальных машин. |
UpdateFromYaml | Обновляет указанную группу виртуальных машин из YAML-файла. |
Stop | Останавливает указанную группу виртуальных машин. |
Start | Запускает указанную группу виртуальных машин. |
Delete | Удаляет указанную группу виртуальных машин. |
ListInstances | Возвращает список виртуальных машин для указанной группы ВМ. |
ListOperations | Возвращает список операций для указанной группы виртуальных машин. |
ListLogRecords | Возвращает список логов для указанной группы виртуальных машин. |
Вызовы InstanceGroupService
Get
Возвращает указанный ресурс InstanceGroup.
Чтобы получить список доступных ресурсов InstanceGroup, используйте запрос List.
rpc Get (GetInstanceGroupRequest) returns (InstanceGroup)
GetInstanceGroupRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор возвращаемого ресурса InstanceGroup. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
view | enum InstanceGroupView Определяет, какая информация о ресурсе Instance должна быть возвращена в ответе.
|
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
List
Возвращает список доступных ресурсов InstanceGroup в указанном каталоге.
rpc List (ListInstanceGroupsRequest) returns (ListInstanceGroupsResponse)
ListInstanceGroupsRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка групп виртуальных машин. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstanceGroupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstanceGroupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю InstanceGroup.name. Максимальная длина строки в символах — 1000. |
view | enum InstanceGroupView Определяет, какая информация о ресурсе Instance должна быть возвращена в ответе.
|
ListInstanceGroupsResponse
Поле | Описание |
---|---|
instance_groups[] | InstanceGroup Список групп виртуальных машин для указанного каталога. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstanceGroupsRequest.page_size, используйте next_page_token в качестве значения параметра ListInstanceGroupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Create
Создает группу виртуальных машин в указанном каталоге. Этот метод запускает операцию, которая может быть отменена другой операцией.
rpc Create (CreateInstanceGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateInstanceGroupMetadata
Operation.response:InstanceGroup
CreateInstanceGroupRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для создания группы виртуальных машин. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
name | string Имя группы виртуальных машин. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание группы виртуальных машин. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
instance_template | InstanceTemplate Обязательное поле. Шаблон виртуальной машины, на основе которого создается группа ВМ. |
scale_policy | ScalePolicy Обязательное поле. Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Обязательное поле. Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Обязательное поле. Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т.п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
CreateInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор создаваемой группы виртуальных машин. Максимальная длина строки в символах — 50. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
CreateFromYaml
Создает группу виртуальных машин в указанном каталоге из YAML-файла. Этот метод запускает операцию, которая может быть отменена другой операцией.
rpc CreateFromYaml (CreateInstanceGroupFromYamlRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateInstanceGroupMetadata
Operation.response:InstanceGroup
CreateInstanceGroupFromYamlRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для создания группы виртуальных машин. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
instance_group_yaml | string Обязательное поле. InstanceGroupService.Create request in YAML format. Максимальная длина строки в символах — 1048576. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
CreateInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор создаваемой группы виртуальных машин. Максимальная длина строки в символах — 50. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Update
Изменяет указанную группу виртуальных машин. Этот метод запускает операцию, которая может быть отменена другой операцией.
rpc Update (UpdateInstanceGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateInstanceGroupMetadata
Operation.response:InstanceGroup
UpdateInstanceGroupRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор обновляемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля ресурса InstanceGroup будут обновлены. |
name | string Имя группы виртуальных машин. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание группы виртуальных машин. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
instance_template | InstanceTemplate Обязательное поле. Шаблон виртуальной машины, на основе которого создается группа ВМ. |
scale_policy | ScalePolicy Обязательное поле. Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Обязательное поле. Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Обязательное поле. Политика распределения группы виртуальных машин по зонам и регионам. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т.п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки для управления распределением нагрузки. |
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
UpdateInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор изменяемого ресурса InstanceGroup. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
UpdateFromYaml
Обновляет указанную группу виртуальных машин из YAML-файла. Этот метод запускает операцию, которая может быть отменена другой операцией.
rpc UpdateFromYaml (UpdateInstanceGroupFromYamlRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateInstanceGroupMetadata
Operation.response:InstanceGroup
UpdateInstanceGroupFromYamlRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор обновляемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
instance_group_yaml | string Обязательное поле. InstanceGroupService.Update request in YAML format. Максимальная длина строки в символах — 1048576. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
UpdateInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор изменяемого ресурса InstanceGroup. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Stop
Останавливает указанную группу виртуальных машин.
rpc Stop (StopInstanceGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StopInstanceGroupMetadata
Operation.response:InstanceGroup
StopInstanceGroupRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор останавливаемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<StopInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
StopInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор останавливаемой группы виртуальных машин. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Start
Запускает указанную группу виртуальных машин.
rpc Start (StartInstanceGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartInstanceGroupMetadata
Operation.response:InstanceGroup
StartInstanceGroupRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор запускаемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<StartInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<InstanceGroup> в случае успешного выполнения операции. |
StartInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор запускаемой группы виртуальных машин. |
InstanceGroup
Поле | Описание |
---|---|
id | string Идентификатор группы виртуальных машин. |
folder_id | string Идентификатор каталога, которому принадлежит группа виртуальных машин. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате RFC3339 . |
name | string Имя группы виртуальных машин. Имя уникально в рамках каталога. |
description | string Описание группы виртуальных машин. |
labels | map<string,string> Метки ресурса в формате ключ:значение . |
instance_template | InstanceTemplate Шаблон виртуальной машины для создания группы ВМ. Дополнительные сведения см. в разделе Шаблон виртуальной машины. |
scale_policy | ScalePolicy Политика масштабирования группы виртуальных машин. |
deploy_policy | DeployPolicy Политика развертывания группы виртуальных машин. |
allocation_policy | AllocationPolicy Политика распределения группы виртуальных машин по зонам и регионам. |
load_balancer_state | LoadBalancerState Информация, указывающая, какие объекты связаны с данным балансировщиком. |
managed_instances_state | ManagedInstancesState Состояния виртуальных машин для данной группы ВМ. |
load_balancer_spec | LoadBalancerSpec Спецификация балансировщика нагрузки. |
health_checks_spec | HealthChecksSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. |
service_account_id | string Идентификатор сервисного аккаунта. Сервисный аккаунт будет использоваться для всех вызовов API, выполняемых компонентом Instance Groups от имени пользователя (например, создание экземпляров, добавление их в целевую группу балансировщика нагрузки и т. п.). Дополнительные сведения см. в разделе Сервисные аккаунты. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
status | enum Status Статус группы виртуальных машин.
|
InstanceTemplate
Поле | Описание |
---|---|
description | string Описание шаблона виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Спецификация загрузочного диска, который будет подключен к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков, которые будут подключенны к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Массив сетевых интерфейсов, которые будут присоединены к виртуальной машине. Количество элементов должно быть ровно 1. |
scheduling_policy | SchedulingPolicy Политика планирования. |
service_account_id | string Идентификатор сервисного аккаунта для привязки к виртуальной машине. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Обязательное поле. Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Значение должно соответствовать регулярному выражению |[a-z][-_0-9a-z]{0,19} . |
disk_spec | DiskSpec Обязательное поле. Спецификация загрузочного диска, для подключения к виртуальной машине. Дополнительные сведения см. в разделе Диски. |
DiskSpec
Поле | Описание |
---|---|
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Обязательное поле. Идентификатор типа диска. |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source_oneof | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа, из которого будет создан диск. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан диск. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
network_id | string Идентификатор облачной сети. |
subnet_ids[] | string Идентификаторы подсетей. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы виртуальных машин. |
auto_scale | AutoScale Политика автоматического масштабирования группы виртуальных машин. |
AutoScale
Поле | Описание |
---|---|
min_zone_size | int64 Минимальное количество виртуальных машин в каждой зоне. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное общее количество виртуальных машин (по всем зонам). 0 означает максимальное значение — 100. Допустимые значения — от 0 до 100 включительно. |
measurement_duration | google.protobuf.Duration Обязательное поле. Время в секундах, отведенное на усреднение метрик. Допустимые значения — от 1m до 10m включительно. |
warmup_duration | google.protobuf.Duration Время прогрева виртуальной машины в секундах. В течение этого времени трафик подается на виртуальную машину, но метрики с этой машины не учитываются. Максимальное значение — 10m. |
stabilization_duration | google.protobuf.Duration Минимальный временной интервал в секундах для мониторинга, перед тем как Instance Groups сможет уменьшить количество виртуальных машин в группе. В течение этого времени размер группы не уменьшается, даже если новые значения метрики указывают, что он должен уменьшаться. Допустимые значения — от 1m до 30m включительно. |
initial_size | int64 Размер целевой группы. Минимальная значение — 1. |
cpu_utilization_rule | CpuUtilizationRule Определяет правило автомасштабирования на основе средней нагрузки CPU для группы виртуальных машин. |
custom_rules[] | CustomRule Определяет правило автомасштабирования на основе пользовательской метрики из Yandex Monitoring. Максимальное количество элементов — 1. |
CpuUtilizationRule
Поле | Описание |
---|---|
utilization_target | double Целевой уровень нагрузки CPU. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Допустимые значения — от 10 до 100 включительно. |
CustomRule
Поле | Описание |
---|---|
rule_type | enum RuleType Обязательное поле. Тип правил применения пользовательской метрики. Это поле влияет на то, какая метка из пользовательской метрики должна использоваться: zone_id или instance_id .
|
metric_type | enum MetricType Обязательное поле. Тип подсчета пользовательской метрики. Это поле влияет на то, как Instance Groups вычисляет среднее значение метрики.
|
metric_name | string Обязательное поле. Название пользовательской метрики в Yandex Monitoring, которая должна использоваться для масштабирования. Значение должно соответствовать регулярному выражению [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
target | double Целевое значение для пользовательской метрики. Instance Groups будет поддерживать этот уровень для каждой зоны доступности. Значение должно быть больше 0. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество виртуальных машин в группе ВМ. Допустимые значения — от 1 до 100 включительно. |
DeployPolicy
Поле | Описание |
---|---|
max_unavailable | int64 Максимальное количество запущенных виртуальных машин, которое можно одновременно отключить (остановить или удалить) в процессе обновления группы. Если max_expansion не указано или равно нулю, max_unavailable должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
max_deleting | int64 Максимальное количество удаляемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_creating | int64 Максимальное количество создаваемых одновременно виртуальных машин. Значение 0 — любое количество виртуальных машин в рамках допустимых значений. Допустимые значения — от 0 до 100 включительно. |
max_expansion | int64 Максимальное количество виртуальных машин, на которое можно превысить целевой размер группы в процессе ее обновления. Если max_unavailable не указан или равен нулю, max_expansion должно быть ненулевым. Допустимые значения — от 0 до 100 включительно. |
startup_duration | google.protobuf.Duration Продолжительность запуска виртуальной машины. Виртуальная машина будет запущена и начнет получать трафик только после того, как истечет startup_duration и будут пройдены все проверки работоспособности. Подробное описание см. в yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status . Допустимые значения — от 0m до 1h включительно. |
AllocationPolicy
Поле | Описание |
---|---|
zones[] | Zone Список зон доступности. Минимальное количество элементов — 1. |
Zone
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. |
LoadBalancerState
Поле | Описание |
---|---|
target_group_id | string Идентификатор целевой группы для распределения нагрузки. |
status_message | string Сообщение о состоянии целевой группы. |
ManagedInstancesState
Поле | Описание |
---|---|
target_size | int64 Целевое количество виртуальных машин для данной группы ВМ. |
running_actual_count | int64 Число запущенных виртуальных машин, соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 Число запущенных виртуальных машин, не соответствующих текущему шаблону. Дополнительные сведения см. в разделе ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 Количество виртуальных машин, находящихся в процессе обновления, запуска, удаления. Дополнительные сведения см. в разделе ManagedInstance.Status. |
Statuses
Поле | Описание |
---|---|
creating | int64 Виртуальная машина создается. |
starting | int64 Виртуальная машина запускается. |
opening | int64 Виртуальная машина открывается для получения трафика. |
warming | int64 Виртуальная машина прогревается. |
running | int64 Виртуальная машина работает нормально. |
closing | int64 Виртуальная машина закрывается для получения трафика. |
stopping | int64 Виртуальная машина останавливается. |
updating | int64 Виртуальная машина обновляется. |
deleting | int64 Виртуальная машина удаляется. |
failed | int64 Сбой виртуальной машины, которую необходимо пересоздать. |
LoadBalancerSpec
Поле | Описание |
---|---|
target_group_spec | TargetGroupSpec Спецификация целевой группы, к которой будет добавлена группа виртуальных машин. Дополнительные сведения см. в разделе Целевые ресурсы и группы. |
TargetGroupSpec
Поле | Описание |
---|---|
name | string Имя целевой группы. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание целевой группы. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
HealthChecksSpec
Поле | Описание |
---|---|
health_check_specs[] | HealthCheckSpec Спецификация проверки работоспособности. Дополнительные сведения см. в разделе Проверка состояния ресурсов. Минимальное количество элементов — 1. |
HealthCheckSpec
Поле | Описание |
---|---|
interval | google.protobuf.Duration Интервал проверок. Значение по умолчанию — 2 секунды. Допустимые значения — от 1s до 300s включительно. |
timeout | google.protobuf.Duration Время ожидания ответа. Значение по умолчанию — 1 секунда. Допустимые значения — от 1s до 60s включительно. |
unhealthy_threshold | int64 Количество неудачных проверок, после которого виртуальная машина будет считаться неработающей. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 Количество успешных проверок, после которого виртуальная машина будет считаться работающей нормально. Значение по умолчанию — 2. Значение должно быть равно 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options или http_options |
tcp_options | TcpOptions Параметры для проверки состояний по протоколу TCP. |
http_options | HttpOptions Параметры для проверки состояний по протоколу HTTP. |
TcpOptions
Поле | Описание |
---|---|
port | int64 Порт TCP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
HttpOptions
Поле | Описание |
---|---|
port | int64 Порт HTTP для проверки состояния. Допустимые значения — от 1 до 32767 включительно. |
path | string URL, по которому будут выполняться проверки (для HTTP). |
Delete
Удаляет указанную группу виртуальных машин.
rpc Delete (DeleteInstanceGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteInstanceGroupMetadata
Operation.response:google.protobuf.Empty
DeleteInstanceGroupRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор удаляемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteInstanceGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteInstanceGroupMetadata
Поле | Описание |
---|---|
instance_group_id | string Идентификатор удаляемой группы виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. |
ListInstances
Возвращает список виртуальных машин для указанной группы ВМ.
rpc ListInstances (ListInstanceGroupInstancesRequest) returns (ListInstanceGroupInstancesResponse)
ListInstanceGroupInstancesRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор ресурса InstanceGroup для получения списка виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstanceGroupInstancesResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstanceGroupInstancesResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю InstanceGroup.name. Максимальная длина строки в символах — 1000. |
ListInstanceGroupInstancesResponse
Поле | Описание |
---|---|
instances[] | ManagedInstance Возвращает список виртуальных машин для указанной группы ВМ. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstanceGroupInstancesRequest.page_size, используйте next_page_token в качестве значения параметра ListInstanceGroupInstancesRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
ManagedInstance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
status | enum Status Статус виртуальной машины.
|
instance_id | string Идентификатор виртуальной машины. |
fqdn | string Полное имя домена. |
name | string Имя управляемой виртуальной машины. |
status_message | string Сообщение о состоянии виртуальной машины. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
status_changed_at | google.protobuf.Timestamp Время последнего изменения состояния виртуальной машины в формате RFC3339. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. Если не указано, системой будет назначен неиспользуемый внутренний IP-адрес. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
ip_version | enum IpVersion Версия публичного IP-адреса.
|
ListOperations
Возвращает список операций для указанной группы виртуальных машин.
rpc ListOperations (ListInstanceGroupOperationsRequest) returns (ListInstanceGroupOperationsResponse)
ListInstanceGroupOperationsRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор ресурса InstanceGroup, для которого запрашивается список операций. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstanceGroupOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstanceGroupOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю InstanceGroup.name. Максимальная длина строки в символах — 1000. |
ListInstanceGroupOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Возвращает список операций для указанной группы виртуальных машин. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstanceGroupOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListInstanceGroupOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |
ListLogRecords
Возвращает список логов для указанной группы виртуальных машин.
rpc ListLogRecords (ListInstanceGroupLogRecordsRequest) returns (ListInstanceGroupLogRecordsResponse)
ListInstanceGroupLogRecordsRequest
Поле | Описание |
---|---|
instance_group_id | string Обязательное поле. Идентификатор ресурса InstanceGroup для получения списка логов. Чтобы получить идентификатор группы виртуальных машин, используйте запрос InstanceGroupService.List. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstanceGroupLogRecordsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstanceGroupLogRecordsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю InstanceGroup.name. Максимальная длина строки в символах — 1000. |
ListInstanceGroupLogRecordsResponse
Поле | Описание |
---|---|
log_records[] | LogRecord Возвращает список логов для указанной группы виртуальных машин. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstanceGroupLogRecordsRequest.page_size, используйте next_page_token в качестве значения параметра ListInstanceGroupLogRecordsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
LogRecord
Поле | Описание |
---|---|
timestamp | google.protobuf.Timestamp Время записи лога в формате RFC3339. |
message | string Сообщение. |