Method update

Required. ID of the instance group to update. To get the instance group ID, use a list request.

The maximum string length in characters is 50.

Field mask that specifies which fields of the InstanceGroup resource are going to be updated.

A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

Name of the instance group.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

Description of the instance group.

The maximum string length in characters is 256.

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 string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\@0-9a-z]*.

Required. Instance template that the instance group belongs to.

Description of the instance template.

The maximum string length in characters is 256.

Resource labels as key:value pairs.

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. The maximum string length in characters for each value is 128.

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.

Required. Computing resources of the instance such as the amount of memory and number of cores.

The amount of memory available to the instance, specified in bytes.

The maximum value is 824633720832.

The number of cores available to the instance.

Value must be one of 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 or 80.

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 one of 0, 5, 20, 50 or 100.

The number of GPUs available to the instance.

Value must be one of 0, 1, 2 or 4.

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 string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 262144.

Required. Boot disk specification that will be attached to the instance.

Required. Access mode to the Disk resource.

• READ_ONLY: Read-only access.
• READ_WRITE: Read/Write access.

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 |[a-z][-_0-9a-z]{0,19}.

Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks.

Description of the disk.

The maximum string length in characters is 256.

Required. ID of the disk type.

Size of the disk, specified in bytes.

Acceptable values are 4194304 to 28587302322176, inclusive.

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.

ID of the image that will be used for disk creation.

The maximum string length in characters is 50.

ID of the snapshot that will be used for disk creation.

The maximum string length in characters is 50.

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

Array of secondary disks that will be attached to the instance.

The maximum number of elements is 3.

Required. Access mode to the Disk resource.

• READ_ONLY: Read-only access.
• READ_WRITE: Read/Write access.

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 |[a-z][-_0-9a-z]{0,19}.

Required. oneof disk_spec or disk_id Disk specification that is attached to the instance. For more information, see Disks.

Description of the disk.

The maximum string length in characters is 256.

Required. ID of the disk type.

Size of the disk, specified in bytes.

Acceptable values are 4194304 to 28587302322176, inclusive.

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.

ID of the image that will be used for disk creation.

The maximum string length in characters is 50.

ID of the snapshot that will be used for disk creation.

The maximum string length in characters is 50.

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

Required. Array of network interfaces that will be attached to the instance.

Must contain exactly 1 element.

ID of the network.

IDs of the subnets.

Primary IPv4 address that is assigned to the instance for this network interface.

An external IP address configuration. If not specified, then this managed instance will have no external internet access.

IP version for the public IP address.

• IPV4: IPv4 address, for example 192.168.0.0.
• IPV6: IPv6 address, not available yet.

Manual set static public IP. To set use variables. (optional)

External DNS configuration

Required. FQDN (required)

DNS zone id (optional, if not set, private zone used)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.

When set to true, also create PTR DNS record (optional)

Internal DNS configuration

Required. FQDN (required)

DNS zone id (optional, if not set, private zone used)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.

When set to true, also create PTR DNS record (optional)

Optional. Manual set static internal IP. To set use variables.

Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet.

An external IP address configuration. If not specified, then this managed instance will have no external internet access.

IP version for the public IP address.

• IPV4: IPv4 address, for example 192.168.0.0.
• IPV6: IPv6 address, not available yet.

Manual set static public IP. To set use variables. (optional)

External DNS configuration

Required. FQDN (required)

DNS zone id (optional, if not set, private zone used)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.

When set to true, also create PTR DNS record (optional)

Internal DNS configuration

Required. FQDN (required)

DNS zone id (optional, if not set, private zone used)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.

When set to true, also create PTR DNS record (optional)

Optional. Manual set static internal IP. To set use variables.

IDs of security groups.

Scheduling policy for the instance.

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.

Service account ID for the instance.

Network settings for the instance.

Type of instance network.

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.

Host name for the instance. This field is used to generate the Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to 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 Group

Identifier of placement group

List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

Include or exclude action

Affinity value or host ID or host group ID

Array of filesystems to attach to the instance.

The filesystems must reside in the same availability zone as the instance.

To use the instance with an attached filesystem, the latter must be mounted. For details, see documentation.

Mode of access to the filesystem that should be attached.

• READ_ONLY: Read-only access.
• READ_WRITE: Read/Write access. Default value.

Name of the device representing the filesystem on the instance.

The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.

If not specified, a random value will be generated.

Value must match the regular expression |[a-z][-_0-9a-z]{0,19}.

ID of the filesystem that should be attached.

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

Required. Scaling policy of the instance group.

Lower limit for instance count in each zone.

Acceptable values are 0 to 100, inclusive.

Upper limit for total instance count (across all zones). 0 means maximum limit = 100.

Acceptable values are 0 to 100, inclusive.

Time in seconds allotted for averaging metrics. 1 minute by default.

Acceptable values are 60 seconds to 600 seconds, inclusive.

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 600 seconds.

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 60 seconds to 1800 seconds, inclusive.

Target group size.

The minimum value is 1.

Defines an autoscaling rule based on the average CPU utilization of the instance group.

If more than one rule is specified, e.g. CPU utilization and one or more Monitoring metrics (customRules), the size of the instance group will be equal to the maximum of sizes calculated according to each metric.

Target CPU utilization level. Instance Groups maintains this level for each availability zone.

Acceptable values are 10 to 100, inclusive.

Defines an autoscaling rule based on a custom metric from Monitoring.

If more than one rule is specified, e.g. CPU utilization (cpuUtilizationRule) and one or more Monitoring metrics, the size of the instance group will be equal to the maximum of sizes calculated according to each metric.

The maximum number of elements is 3.

Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id.

• UTILIZATION: This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone or in whole group depends on autoscaling type. This type of metric must have the instance_id label.
• WORKLOAD: This type means that the metric applies to instances in one availability zone or to whole group depends on autoscaling type. This type of metric must have the zone_id label if ZONAL autoscaling type is chosen.

Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.

• GAUGE: This type is used for metrics that show the metric value at a certain point in time, such as requests per second to the server on an instance.

  Instance Groups calculates the average metric value for the period specified in the measurementDuration field.

• COUNTER: This type is used for metrics that monotonically increase over time, such as the total number of requests to the server on an instance.

  Instance Groups calculates the average value increase for the period specified in the measurementDuration field.

Required. Name of custom metric in Monitoring that should be used for scaling.

Value must match the regular expression [a-zA-Z0-9./@_][ 0-9a-zA-Z./@_,:;()\[\]<>-]{0,198}.

Labels of custom metric in Monitoring that should be used for scaling.

Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$. Each value must match the regular expression [a-zA-Z0-9./@_][ 0-9a-zA-Z./@_,:;()\[\]<>-]{0,198}.

Target value for the custom metric. Instance Groups maintains this level for each availability zone.

Value must be greater than 0.

Folder id of custom metric in Monitoring that should be used for scaling.

The maximum string length in characters is 50.

Service of custom metric in Monitoring that should be used for scaling.

The maximum string length in characters is 200.

Autoscaling type.

• ZONAL: Scale each zone independently. This is the default.
• REGIONAL: Scale group as a whole.

Number of instances in the instance group.

Acceptable values are 1 to 100, inclusive.

Lower limit for instance count in each zone.

Acceptable values are 0 to 100, inclusive.

Upper limit for total instance count (across all zones). 0 means maximum limit = 100.

Acceptable values are 0 to 100, inclusive.

Time in seconds allotted for averaging metrics. 1 minute by default.

Acceptable values are 60 seconds to 600 seconds, inclusive.

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 600 seconds.

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 60 seconds to 1800 seconds, inclusive.

Target group size.

The minimum value is 1.

Defines an autoscaling rule based on the average CPU utilization of the instance group.

If more than one rule is specified, e.g. CPU utilization and one or more Monitoring metrics (customRules), the size of the instance group will be equal to the maximum of sizes calculated according to each metric.

Target CPU utilization level. Instance Groups maintains this level for each availability zone.

Acceptable values are 10 to 100, inclusive.

Defines an autoscaling rule based on a custom metric from Monitoring.

If more than one rule is specified, e.g. CPU utilization (cpuUtilizationRule) and one or more Monitoring metrics, the size of the instance group will be equal to the maximum of sizes calculated according to each metric.

The maximum number of elements is 3.

Required. Custom metric rule type. This field affects which label from the custom metric should be used: zone_id or instance_id.

• UTILIZATION: This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone or in whole group depends on autoscaling type. This type of metric must have the instance_id label.
• WORKLOAD: This type means that the metric applies to instances in one availability zone or to whole group depends on autoscaling type. This type of metric must have the zone_id label if ZONAL autoscaling type is chosen.

Required. Type of custom metric. This field affects how Instance Groups calculates the average metric value.

• GAUGE: This type is used for metrics that show the metric value at a certain point in time, such as requests per second to the server on an instance.

  Instance Groups calculates the average metric value for the period specified in the measurementDuration field.

• COUNTER: This type is used for metrics that monotonically increase over time, such as the total number of requests to the server on an instance.

  Instance Groups calculates the average value increase for the period specified in the measurementDuration field.

Required. Name of custom metric in Monitoring that should be used for scaling.

Value must match the regular expression [a-zA-Z0-9./@_][ 0-9a-zA-Z./@_,:;()\[\]<>-]{0,198}.

Labels of custom metric in Monitoring that should be used for scaling.

Each key must match the regular expression ^[a-zA-Z][0-9a-zA-Z_]{0,31}$. Each value must match the regular expression [a-zA-Z0-9./@_][ 0-9a-zA-Z./@_,:;()\[\]<>-]{0,198}.

Target value for the custom metric. Instance Groups maintains this level for each availability zone.

Value must be greater than 0.

Folder id of custom metric in Monitoring that should be used for scaling.

The maximum string length in characters is 50.

Service of custom metric in Monitoring that should be used for scaling.

The maximum string length in characters is 200.

Autoscaling type.

• ZONAL: Scale each zone independently. This is the default.
• REGIONAL: Scale group as a whole.

Required. Deployment policy of the instance group.

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 maxExpansion is not specified or set to zero, maxUnavailable must be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

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.

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.

The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If maxUnavailable is not specified or set to zero, maxExpansion must be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

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 ManagedInstanceStatus for more information.

Acceptable values are 0 seconds to 3600 seconds, inclusive.

Affects the lifecycle of the instance during deployment.

• PROACTIVE: Instance Groups can forcefully stop a running instance. This is the default.
• OPPORTUNISTIC: Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

Required. Allocation policy of the instance group by zones and regions.

Required. List of availability zones.

The minimum number of elements is 1.

Required. ID of the availability zone where the instance resides.

Health checking specification. For more information, see Health check.

Required. Health checking specification. For more information, see Health check.

The minimum number of elements is 1.

The interval between health checks. The default is 2 seconds.

Acceptable values are 1 seconds to 300 seconds, inclusive.

Timeout for the managed instance to return a response for the health check. The default is 1 second.

Acceptable values are 1 seconds to 60 seconds, inclusive.

The number of failed health checks for the managed instance to be considered unhealthy. The default (0) is 2.

Value must be one of 0, 2, 3, 4, 5, 6, 7, 8, 9 or 10.

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 one of 0, 2, 3, 4, 5, 6, 7, 8, 9 or 10.

Port to use for TCP health checks.

Acceptable values are 1 to 65535, inclusive.

Port to use for HTTP health checks.

Acceptable values are 1 to 65535, inclusive.

URL path to set for health checking requests.

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

The minimum value is 1 seconds.

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 list request.

Settings for balancing load between instances via Network Load Balancer (OSI model layer 3).

Specification of the target group that the instance group will be added to. For more information, see Target groups and resources.

Name of the target group.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

Description of the target group.

The maximum string length in characters is 256.

Resource labels as key:value pairs.

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\@0-9a-z]*.

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

The minimum value is 1 seconds.

The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]*.

The maximum string length in characters is 128.

Flag that inhibits deletion of the instance group

Settings for balancing load between instances via Application Load Balancer (OSI model layer 7).

Required. Basic properties of the Application Load Balancer target group attributed to the instance group.

Name of the target group.

Description of the target group.

Resource labels as key:value pairs.

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

The minimum value is 1 seconds.

ID of the operation.

Description of the operation. 0-256 characters long.

Creation timestamp.

String in RFC3339 text format.

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

The time when the Operation resource was last modified.

String in RFC3339 text format.

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.

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

Error code. An enum value of google.rpc.Code.

An error message.

A list of messages that carry the error details.

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.