InstanceGroupService
- Calls InstanceGroupService
- Get
- GetInstanceGroupRequest
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- List
- ListInstanceGroupsRequest
- ListInstanceGroupsResponse
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Create
- CreateInstanceGroupRequest
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Operation
- CreateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- CreateFromYaml
- CreateInstanceGroupFromYamlRequest
- Operation
- CreateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Update
- UpdateInstanceGroupRequest
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- LoadBalancerSpec
- TargetGroupSpec
- Variable
- Operation
- UpdateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- UpdateFromYaml
- UpdateInstanceGroupFromYamlRequest
- Operation
- UpdateInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Stop
- StopInstanceGroupRequest
- Operation
- StopInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Start
- StartInstanceGroupRequest
- Operation
- StartInstanceGroupMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- Delete
- ListInstances
- DeleteInstances
- DeleteInstancesRequest
- Operation
- DeleteInstancesMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- StopInstances
- StopInstancesRequest
- Operation
- StopInstancesMetadata
- InstanceGroup
- InstanceTemplate
- ResourcesSpec
- AttachedDiskSpec
- DiskSpec
- NetworkInterfaceSpec
- PrimaryAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- ScalePolicy
- AutoScale
- CpuUtilizationRule
- CustomRule
- FixedScale
- DeployPolicy
- AllocationPolicy
- Zone
- LoadBalancerState
- ManagedInstancesState
- Statuses
- LoadBalancerSpec
- TargetGroupSpec
- HealthChecksSpec
- HealthCheckSpec
- TcpOptions
- HttpOptions
- Variable
- ListOperations
- ListLogRecords
- ListAccessBindings
- SetAccessBindings
- UpdateAccessBindings
A set of methods for managing InstanceGroup resources.
Call | Description |
---|---|
Get | Returns the specified InstanceGroup resource. |
List | Retrieves the list of InstanceGroup resources in the specified folder. |
Create | Creates an instance group in the specified folder. |
CreateFromYaml | Creates an instance group in the specified folder from a YAML file. |
Update | Updates the specified instance group. |
UpdateFromYaml | Updates the specified instance group from a YAML file. |
Stop | Stops the specified instance group. |
Start | Starts the specified instance group. |
Delete | Deletes the specified instance group. |
ListInstances | Lists instances for the specified instance group. |
DeleteInstances | Delete instances from the instance group. |
StopInstances | Stop instances from the instance group. |
ListOperations | Lists operations for the specified instance group. |
ListLogRecords | Lists logs for the specified instance group. |
ListAccessBindings | Lists existing access bindings for the specified instance group. |
SetAccessBindings | Sets access bindings for the specified instance group. |
UpdateAccessBindings | Updates access bindings for the specified instance group. |
Calls InstanceGroupService
Get
Returns the specified InstanceGroup resource.
To get the list of available InstanceGroup resources, make a List request.
rpc Get (GetInstanceGroupRequest) returns (InstanceGroup)
GetInstanceGroupRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the InstanceGroup resource to return. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
view | enum InstanceGroupView Defines which information about the Instance template should be returned in the server response.
|
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
List
Retrieves the list of InstanceGroup resources in the specified folder.
rpc List (ListInstanceGroupsRequest) returns (ListInstanceGroupsResponse)
ListInstanceGroupsRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list instance groups in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListInstanceGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListInstanceGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on the InstanceGroup.name field. The maximum string length in characters is 1000. |
view | enum InstanceGroupView Defines which information about the Instance template should be returned in the server response.
|
ListInstanceGroupsResponse
Field | Description |
---|---|
instance_groups[] | InstanceGroup Lists instance groups for the specified folder. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListInstanceGroupsRequest.page_size, use next_page_token as the value for the ListInstanceGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Create
Creates an instance group in the specified folder. This method starts an operation that can be cancelled by another operation.
rpc Create (CreateInstanceGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateInstanceGroupMetadata
Operation.response:InstanceGroup
CreateInstanceGroupRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create an instance group in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
name | string Name of the instance group. Value must match the regular expression ` |
description | string Description of the instance group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
instance_template | InstanceTemplate Required. Instance template that the instance group belongs to. |
scale_policy | ScalePolicy Required. Scaling policy of the instance group. |
deploy_policy | DeployPolicy Required. Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Required. Allocation policy of the instance group by zones and regions. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<CreateInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
CreateInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the instance group that is being created. The maximum string length in characters is 50. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
CreateFromYaml
Creates an instance group in the specified folder from a YAML file. This method starts an operation that can be cancelled by another operation.
rpc CreateFromYaml (CreateInstanceGroupFromYamlRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateInstanceGroupMetadata
Operation.response:InstanceGroup
CreateInstanceGroupFromYamlRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create an instance group in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
instance_group_yaml | string Required. InstanceGroupService.Create request in YAML format. The maximum string length in characters is 1048576. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<CreateInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
CreateInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the instance group that is being created. The maximum string length in characters is 50. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Update
Updates the specified instance group. This method starts an operation that can be cancelled by another operation.
rpc Update (UpdateInstanceGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateInstanceGroupMetadata
Operation.response:InstanceGroup
UpdateInstanceGroupRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group to update. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the InstanceGroup resource are going to be updated. |
name | string Name of the instance group. Value must match the regular expression ` |
description | string Description of the instance group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. The existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
instance_template | InstanceTemplate Required. Instance template that the instance group belongs to. |
scale_policy | ScalePolicy Required. Scaling policy of the instance group. |
deploy_policy | DeployPolicy Required. Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Required. Allocation policy of the instance group by zones and regions. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
load_balancer_spec | LoadBalancerSpec Load Balancer specification for load balancing support. |
variables[] | Variable |
deletion_protection | bool Flag that inhibits deletion of the instance group |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<UpdateInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
UpdateInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the InstanceGroup resource that is being updated. To get the instance group ID, use a InstanceGroupService.List request. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
UpdateFromYaml
Updates the specified instance group from a YAML file. This method starts an operation that can be cancelled by another operation.
rpc UpdateFromYaml (UpdateInstanceGroupFromYamlRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateInstanceGroupMetadata
Operation.response:InstanceGroup
UpdateInstanceGroupFromYamlRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group to update. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
instance_group_yaml | string Required. InstanceGroupService.Update request in YAML format. The maximum string length in characters is 1048576. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<UpdateInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
UpdateInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the InstanceGroup resource that is being updated. To get the instance group ID, use a InstanceGroupService.List request. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Stop
Stops the specified instance group.
rpc Stop (StopInstanceGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopInstanceGroupMetadata
Operation.response:InstanceGroup
StopInstanceGroupRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group to stop. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<StopInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
StopInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the InstanceGroup resource that is being stopped. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Start
Starts the specified instance group.
rpc Start (StartInstanceGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartInstanceGroupMetadata
Operation.response:InstanceGroup
StartInstanceGroupRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group to start. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<StartInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
StartInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the InstanceGroup resource that is being started. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
Delete
Deletes the specified instance group.
rpc Delete (DeleteInstanceGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteInstanceGroupMetadata
Operation.response:google.protobuf.Empty
DeleteInstanceGroupRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group to delete. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<DeleteInstanceGroupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<google.protobuf.Empty> if operation finished successfully. |
DeleteInstanceGroupMetadata
Field | Description |
---|---|
instance_group_id | string ID of the instance group that is being deleted. To get the instance group ID, use a InstanceGroupService.List request. |
ListInstances
Lists instances for the specified instance group.
rpc ListInstances (ListInstanceGroupInstancesRequest) returns (ListInstanceGroupInstancesResponse)
ListInstanceGroupInstancesRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the InstanceGroup resource to list instances for. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListInstanceGroupInstancesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListInstanceGroupInstancesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on the InstanceGroup.name field. The maximum string length in characters is 1000. |
ListInstanceGroupInstancesResponse
Field | Description |
---|---|
instances[] | ManagedInstance Lists instances for the specified instance group. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is more than ListInstanceGroupInstancesRequest.page_size, use next_page_token as the value for the ListInstanceGroupInstancesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
ManagedInstance
Field | Description |
---|---|
id | string ID of the managed instance. |
status | enum Status Status of the managed instance.
|
instance_id | string ID of the instance. |
fqdn | string Fully Qualified Domain Name. |
name | string The name of the managed instance. |
status_message | string Status message for the managed instance. |
zone_id | string ID of the availability zone where the instance resides. |
network_interfaces[] | NetworkInterface Array of network interfaces that are attached to the managed instance. |
status_changed_at | google.protobuf.Timestamp The timestamp in RFC3339 text format when the status of the managed instance was last changed. |
NetworkInterface
Field | Description |
---|---|
index | string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance. |
mac_address | string MAC address that is assigned to the network interface. |
subnet_id | string ID of the subnet. |
primary_v4_address | PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address | PrimaryAddress Primary IPv6 address that is assigned to the instance for this network interface. IPv6 is not available yet. |
PrimaryAddress
Field | Description |
---|---|
address | string An IPv4 internal network address that is assigned to the managed instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
one_to_one_nat | OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up. |
OneToOneNat
Field | Description |
---|---|
address | string An IPv4 external network address that is assigned to the managed instance for this network interface. |
ip_version | enum IpVersion External IP address version.
|
DeleteInstances
Delete instances from the instance group.
rpc DeleteInstances (DeleteInstancesRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteInstancesMetadata
Operation.response:InstanceGroup
DeleteInstancesRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group that the instances are being deleted from. To get the ID of the instance group, use the InstanceGroupService.List request. The maximum string length in characters is 50. |
managed_instance_ids[] | string IDs of the instances to delete. Instances will be deleted along with all dependent resources. Only IDs from the ManagedInstance.id field are allowed, not ManagedInstance.instance_id. The minimum number of elements is 1. The maximum string length in characters for each value is 50. |
create_another | bool If set to true, the target size of instance group will not be reduced and a new instance will be created instead of the deleted one. By default, the target size of instance group will be reduced by the specified number of instance IDs. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<DeleteInstancesMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
DeleteInstancesMetadata
Field | Description |
---|---|
instance_group_id | string ID of the instance group that the instances are being deleted from. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
StopInstances
Stop instances from the instance group.
rpc StopInstances (StopInstancesRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopInstancesMetadata
Operation.response:InstanceGroup
StopInstancesRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the instance group that the instances are being stopped from. To get the ID of the instance group, use the InstanceGroupService.List request. The maximum string length in characters is 50. |
managed_instance_ids[] | string IDs of the instances to stop. After stopping, the instance can be updated, started, or deleted according to scale and deploy policies. Only IDs from the ManagedInstance.id field are allowed, not ManagedInstance.instance_id. The minimum number of elements is 1. The maximum string length in characters for each value is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<StopInstancesMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<InstanceGroup> if operation finished successfully. |
StopInstancesMetadata
Field | Description |
---|---|
instance_group_id | string ID of the instance group that the instances are being stopped from. |
InstanceGroup
Field | Description |
---|---|
id | string ID of the instance group. |
folder_id | string ID of the folder that the instance group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format. |
name | string Name of the instance group. The name is unique within the folder. |
description | string Description of the instance group. |
labels | map<string,string> Resource labels as key:value pairs. |
instance_template | InstanceTemplate Instance template for creating the instance group. For more information, see Instance Templates. |
scale_policy | ScalePolicy Scaling policy of the instance group. |
deploy_policy | DeployPolicy Deployment policy of the instance group. |
allocation_policy | AllocationPolicy Allocation policy of the instance group by zones and regions. |
load_balancer_state | LoadBalancerState Information that indicates which entities can be related to this load balancer. |
managed_instances_state | ManagedInstancesState States of instances for this instance group. |
load_balancer_spec | LoadBalancerSpec Load balancing specification. |
health_checks_spec | HealthChecksSpec Health checking specification. For more information, see Health check. |
service_account_id | string ID of the service account. The service account will be used for all API calls made by the Instance Groups component on behalf of the user (for example, creating instances, adding them to load balancer target group, etc.). For more information, see Service accounts. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
status | enum Status Status of the instance group.
|
variables[] | Variable |
deletion_protection | bool Flag prohibiting deletion of the instance group. Allowed values:- false : The instance group can be deleted.- true : The instance group cannot be deleted. The default is false . |
InstanceTemplate
Field | Description |
---|---|
description | string Description of the instance template. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string Required. ID of the hardware platform configuration for the instance. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms. |
resources_spec | ResourcesSpec Required. Computing resources of the instance such as the amount of memory and number of cores. |
metadata | map<string,string> The metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Metadata values may contain one of the supported placeholders: {instance_group.id} {instance.short_id} {instance.index} {instance.index_in_zone} {instance.zone_id} InstanceGroup and Instance labels may be copied to metadata following way: {instance_group.labels.some_label_key} {instance.labels.another_label_key} These placeholders will be substituted for each created instance anywhere in the value text. In the rare case the value requires to contain this placeholder explicitly, it must be escaped with double brackets, in example {instance.index}. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. No more than 128 per resource. The maximum string length in characters for each value is 262144. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
boot_disk_spec | AttachedDiskSpec Required. Boot disk specification that will be attached to the instance. |
secondary_disk_specs[] | AttachedDiskSpec Array of secondary disks that will be attached to the instance. The maximum number of elements is 3. |
network_interface_specs[] | NetworkInterfaceSpec Array of network interfaces that will be attached to the instance. The number of elemets must be exactly 1. |
scheduling_policy | SchedulingPolicy Scheduling policy for the instance. |
service_account_id | string Service account ID for the instance. |
network_settings | NetworkSettings Network settings for the instance. |
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
hostname | string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal . Otherwise FQDN will be <hostname>.<region_id>.internal . In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, name value will be used It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
placement_policy | PlacementPolicy Placement Group |
ResourcesSpec
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. The maximum value is 824633720832. |
cores | int64 The number of cores available to the instance. Value must be equal to 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,68,72,76,80. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100. |
gpus | int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4. |
AttachedDiskSpec
Field | Description |
---|---|
mode | enum Mode Required. Access mode to the Disk resource.
|
device_name | string Serial number that is reflected in the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. Value must match the regular expression ` |
disk_spec | DiskSpec Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks. |
disk_id | string Set to use an existing disk. To set use variables. The maximum string length in characters is 128. Value must match the regular expression [-a-zA-Z0-9._{}]* . |
DiskSpec
Field | Description |
---|---|
description | string Description of the disk. The maximum string length in characters is 256. |
type_id | string Required. ID of the disk type. |
size | int64 Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive. |
source_oneof | oneof: image_id or snapshot_id |
image_id | string ID of the image that will be used for disk creation. The maximum string length in characters is 50. |
snapshot_id | string ID of the snapshot that will be used for disk creation. The maximum string length in characters is 50. |
preserve_after_instance_delete | bool When set to true, disk will not be deleted even after managed instance is deleted. It will be a user's responsibility to delete such disks. |
NetworkInterfaceSpec
Field | Description |
---|---|
network_id | string ID of the network. |
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | PrimaryAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | PrimaryAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string IDs of security groups. |
PrimaryAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec An external IP address configuration. If not specified, then this managed instance will have no external internet access. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
address | string Manual set static public IP. To set use variables. (optional) |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Type of instance network. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Manual scaling policy of the instance group. |
auto_scale | AutoScale Automatic scaling policy of the instance group. |
test_auto_scale | AutoScale Test spec for automatic scaling policy of the instance group. |
AutoScale
Field | Description |
---|---|
min_zone_size | int64 Lower limit for instance count in each zone. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Upper limit for total instance count (across all zones). 0 means maximum limit = 100. Acceptable values are 0 to 100, inclusive. |
measurement_duration | google.protobuf.Duration Required. Time in seconds allotted for averaging metrics. Acceptable values are 1m to 10m, inclusive. |
warmup_duration | google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 10m. |
stabilization_duration | google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 1m to 30m, inclusive. |
initial_size | int64 Target group size. The minimum value is 1. |
cpu_utilization_rule | CpuUtilizationRule Defines an autoscaling rule based on the average CPU utilization of the instance group. |
custom_rules[] | CustomRule Defines an autoscaling rule based on a custom metric from Yandex Monitoring. The maximum number of elements is 1. |
CpuUtilizationRule
Field | Description |
---|---|
utilization_target | double Target CPU utilization level. Instance Groups maintains this level for each availability zone. Acceptable values are 10 to 100, inclusive. |
CustomRule
Field | Description |
---|---|
rule_type | enum RuleType Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id .
|
metric_type | enum MetricType Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.
|
metric_name | string Required. Name of custom metric in Yandex Monitoring that should be used for scaling. Value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . |
labels | map<string,string> Labels of custom metric in Yandex Monitoring that should be used for scaling. Each value must match the regular expression [a-zA-Z0-9./@_][0-9a-zA-Z./@_,:;()\\[\\]<>-]{0,198} . Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$ . |
target | double Target value for the custom metric. Instance Groups maintains this level for each availability zone. Value must be greater than 0. |
folder_id | string Folder id of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 50. |
service | string Service of custom metric in Yandex Monitoring that should be used for scaling. The maximum string length in characters is 200. |
FixedScale
Field | Description |
---|---|
size | int64 Number of instances in the instance group. Acceptable values are 1 to 100, inclusive. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_deleting | int64 The maximum number of instances that can be deleted at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_creating | int64 The maximum number of instances that can be created at the same time. The value 0 is any number of virtual machines within the allowed values. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
startup_duration | google.protobuf.Duration Instance startup duration. Instance will be considered up and running (and start receiving traffic) only after startup_duration has elapsed and all health checks are passed. See yandex.cloud.compute.v1.instancegroup.ManagedInstance.Status for more information. Acceptable values are 0m to 1h, inclusive. |
strategy | enum Strategy Affects the lifecycle of the instance during deployment.
|
AllocationPolicy
Field | Description |
---|---|
zones[] | Zone List of availability zones. The minimum number of elements is 1. |
Zone
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the instance resides. |
LoadBalancerState
Field | Description |
---|---|
target_group_id | string ID of the target group used for load balancing. |
status_message | string Status message of the target group. |
ManagedInstancesState
Field | Description |
---|---|
target_size | int64 Target number of instances for this instance group. |
running_actual_count | int64 The number of running instances that match the current instance template. For more information, see ManagedInstance.Status.RUNNING_ACTUAL. |
running_outdated_count | int64 The number of running instances that does not match the current instance template. For more information, see ManagedInstance.Status.RUNNING_OUTDATED. |
processing_count | int64 The number of instances in flight (for example, updating, starting, deleting). For more information, see ManagedInstance.Status. |
Statuses
Field | Description |
---|---|
creating | int64 Instance is being created. |
starting | int64 Instance is being started. |
opening | int64 Instance is being opened to receive traffic. |
warming | int64 Instance is being warmed. |
running | int64 Instance is running normally. |
closing | int64 Instance is being closed to traffic. |
stopping | int64 Instance is being stopped. |
updating | int64 Instance is being updated. |
deleting | int64 Instance is being deleted. |
failed | int64 Instance failed and needs to be recreated. |
LoadBalancerSpec
Field | Description |
---|---|
target_group_spec | TargetGroupSpec Specification of the target group that the instance group will be added to. For more information, see Target groups and resources. |
TargetGroupSpec
Field | Description |
---|---|
name | string Name of the target group. Value must match the regular expression ` |
description | string Description of the target group. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
HealthChecksSpec
Field | Description |
---|---|
health_check_specs[] | HealthCheckSpec Health checking specification. For more information, see Health check. The minimum number of elements is 1. |
HealthCheckSpec
Field | Description |
---|---|
interval | google.protobuf.Duration The interval between health checks. The default is 2 seconds. Acceptable values are 1s to 300s, inclusive. |
timeout | google.protobuf.Duration Timeout for the managed instance to return a response for the health check. The default is 1 second. Acceptable values are 1s to 60s, inclusive. |
unhealthy_threshold | int64 The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
healthy_threshold | int64 The number of successful health checks required in order for the managed instance to be considered healthy. The default (0) is 2. Value must be equal to 0,2,3,4,5,6,7,8,9,10. |
health_check_options | oneof: tcp_options or http_options |
tcp_options | TcpOptions Configuration options for a TCP health check. |
http_options | HttpOptions Configuration options for an HTTP health check. |
TcpOptions
Field | Description |
---|---|
port | int64 Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
HttpOptions
Field | Description |
---|---|
port | int64 Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
path | string URL path to set for health checking requests. |
Variable
Field | Description |
---|---|
key | string The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]* . |
value | string The maximum string length in characters is 128. |
ListOperations
Lists operations for the specified instance group.
rpc ListOperations (ListInstanceGroupOperationsRequest) returns (ListInstanceGroupOperationsResponse)
ListInstanceGroupOperationsRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the InstanceGroup resource to list operations for. To get the instance group ID, use a InstanceGroupService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is more than page_size , the service returns a ListInstanceGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListInstanceGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on the InstanceGroup.name field. The maximum string length in characters is 1000. |
ListInstanceGroupOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation Lists operations for the specified instance group. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is more than ListInstanceGroupOperationsRequest.page_size, use the next_page_token as the value for the ListInstanceGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |
ListLogRecords
Lists logs for the specified instance group.
rpc ListLogRecords (ListInstanceGroupLogRecordsRequest) returns (ListInstanceGroupLogRecordsResponse)
ListInstanceGroupLogRecordsRequest
Field | Description |
---|---|
instance_group_id | string Required. ID of the InstanceGroup resource to list logs for. To get the instance group ID, use a InstanceGroupService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListInstanceGroupLogRecordsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListInstanceGroupLogRecordsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on the InstanceGroup.name field. The maximum string length in characters is 1000. |
ListInstanceGroupLogRecordsResponse
Field | Description |
---|---|
log_records[] | LogRecord Lists logs for the specified instance group. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListInstanceGroupLogRecordsRequest.page_size, use next_page_token as the value for the ListInstanceGroupLogRecordsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Log timestamp in RFC3339 text format. |
message | string The log message. |
ListAccessBindings
Lists existing access bindings for the specified instance group.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100. |
ListAccessBindingsResponse
Field | Description |
---|---|
access_bindings[] | AccessBinding List of access bindings for the specified resource. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required.
|
type | string Required.
|
SetAccessBindings
Sets access bindings for the specified instance group.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:SetAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50. |
access_bindings[] | AccessBinding Required. Access bindings to be set. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required.
|
type | string Required.
|
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<SetAccessBindingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<google.protobuf.Empty> if operation finished successfully. |
SetAccessBindingsMetadata
Field | Description |
---|---|
resource_id | string ID of the resource for which access bindings are being set. |
UpdateAccessBindings
Updates access bindings for the specified instance group.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50. |
access_binding_deltas[] | AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0. |
AccessBindingDelta
Field | Description |
---|---|
action | enum AccessBindingAction Required. The action that is being performed on an access binding.
|
access_binding | AccessBinding Required. Access binding. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required.
|
type | string Required.
|
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any<UpdateAccessBindingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<google.protobuf.Empty> if operation finished successfully. |
UpdateAccessBindingsMetadata
Field | Description |
---|---|
resource_id | string ID of the resource for which access bindings are being updated. |