1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceGroupManagers.html">instanceGroupManagers</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</p> 83<p class="toc_element"> 84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<p class="toc_element"> 87 <code><a href="#applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.</p> 89<p class="toc_element"> 90 <code><a href="#close">close()</a></code></p> 91<p class="firstline">Close httplib2 connections.</p> 92<p class="toc_element"> 93 <code><a href="#createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.</p> 95<p class="toc_element"> 96 <code><a href="#delete">delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p> 98<p class="toc_element"> 99 <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.</p> 101<p class="toc_element"> 102 <code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Deletes selected per-instance configs for the managed instance group.</p> 104<p class="toc_element"> 105 <code><a href="#get">get(project, zone, instanceGroupManager, x__xgafv=None)</a></code></p> 106<p class="firstline">Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.</p> 107<p class="toc_element"> 108 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.</p> 110<p class="toc_element"> 111 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p> 113<p class="toc_element"> 114 <code><a href="#listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.</p> 116<p class="toc_element"> 117 <code><a href="#listErrors_next">listErrors_next(previous_request, previous_response)</a></code></p> 118<p class="firstline">Retrieves the next page of results.</p> 119<p class="toc_element"> 120 <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.</p> 122<p class="toc_element"> 123 <code><a href="#listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</a></code></p> 124<p class="firstline">Retrieves the next page of results.</p> 125<p class="toc_element"> 126 <code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.</p> 128<p class="toc_element"> 129 <code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</a></code></p> 130<p class="firstline">Retrieves the next page of results.</p> 131<p class="toc_element"> 132 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 133<p class="firstline">Retrieves the next page of results.</p> 134<p class="toc_element"> 135 <code><a href="#patch">patch(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 136<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.</p> 137<p class="toc_element"> 138 <code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 139<p class="firstline">Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p> 140<p class="toc_element"> 141 <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 142<p class="firstline">Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.</p> 143<p class="toc_element"> 144 <code><a href="#resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</a></code></p> 145<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.</p> 146<p class="toc_element"> 147 <code><a href="#resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 148<p class="firstline">Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.</p> 149<p class="toc_element"> 150 <code><a href="#resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 151<p class="firstline">Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request.</p> 152<p class="toc_element"> 153 <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 154<p class="firstline">Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead.</p> 155<p class="toc_element"> 156 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 157<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.</p> 158<p class="toc_element"> 159 <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 160<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p> 161<p class="toc_element"> 162 <code><a href="#startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 163<p class="firstline">Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.</p> 164<p class="toc_element"> 165 <code><a href="#stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 166<p class="firstline">Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.</p> 167<p class="toc_element"> 168 <code><a href="#suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 169<p class="firstline">Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.</p> 170<p class="toc_element"> 171 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 172<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 173<p class="toc_element"> 174 <code><a href="#update">update(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 175<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.</p> 176<p class="toc_element"> 177 <code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 178<p class="firstline">Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p> 179<h3>Method Details</h3> 180<div class="method"> 181 <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 182 <pre>Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. 183 184Args: 185 project: string, Project ID for this request. (required) 186 zone: string, The name of the zone where the managed instance group is located. (required) 187 instanceGroupManager: string, The name of the managed instance group. (required) 188 body: object, The request body. 189 The object takes the form of: 190 191{ 192 "instances": [ # The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 193 "A String", 194 ], 195} 196 197 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 198 x__xgafv: string, V1 error format. 199 Allowed values 200 1 - v1 error format 201 2 - v2 error format 202 203Returns: 204 An object of the form: 205 206 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 207 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 208 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 209 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 210 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 211 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 212 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 213 { 214 "code": "A String", # [Output Only] The error type identifier for this error. 215 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 216 "message": "A String", # [Output Only] An optional, human-readable error message. 217 }, 218 ], 219 }, 220 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 221 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 222 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 223 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 224 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 225 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 226 "a_key": "", # Properties of the object. Contains field @type with type URL. 227 }, 228 "name": "A String", # [Output Only] Name of the operation. 229 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 230 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 231 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 232 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 233 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 234 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 235 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 236 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 237 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 238 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 239 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 240 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 241 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 242 { 243 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 244 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 245 { 246 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 247 "value": "A String", # [Output Only] A warning data value corresponding to the key. 248 }, 249 ], 250 "message": "A String", # [Output Only] A human-readable description of the warning code. 251 }, 252 ], 253 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 259 <pre>Retrieves the list of managed instance groups and groups them by zone. 260 261Args: 262 project: string, Project ID for this request. (required) 263 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 264 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 265 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 266 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 267 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 268 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 269 x__xgafv: string, V1 error format. 270 Allowed values 271 1 - v1 error format 272 2 - v2 error format 273 274Returns: 275 An object of the form: 276 277 { 278 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 279 "items": { # A list of InstanceGroupManagersScopedList resources. 280 "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups. 281 "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone. 282 { # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 283 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 284 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 285 "labels": { # The label key-value pairs that you want to patch onto the instance. 286 "a_key": "A String", 287 }, 288 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 289 "a_key": "A String", 290 }, 291 }, 292 }, 293 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 294 { 295 "autoHealingTriggers": { # Restricts what triggers autohealing. 296 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 297 }, 298 "healthCheck": "A String", # The URL for the health check that signals autohealing. 299 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 300 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 301 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 302 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 303 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 304 }, 305 "updateInstances": "A String", 306 }, 307 ], 308 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 309 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 310 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 311 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 312 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 313 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 314 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 315 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 316 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 317 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 318 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 319 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 320 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 321 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 322 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 323 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 324 }, 325 "description": "A String", # An optional description of this resource. 326 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 327 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 328 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 329 { 330 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 331 }, 332 ], 333 }, 334 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 335 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 336 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 337 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 338 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 339 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 340 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 341 }, 342 }, 343 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 344 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 345 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 346 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 347 { # The named port. For example: <"http", 80>. 348 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 349 "port": 42, # The port number, which can be a value between 1 and 65535. 350 }, 351 ], 352 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 353 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 354 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 355 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 356 "standbyPolicy": { # Standby policy for stopped and suspended instances. 357 "initialDelaySec": 42, 358 }, 359 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 360 "preservedState": { # Configuration of preserved resources. 361 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 362 "a_key": { 363 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 364 }, 365 }, 366 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 367 "a_key": { 368 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 369 }, 370 }, 371 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 372 "a_key": { 373 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 374 }, 375 }, 376 }, 377 }, 378 "status": { # [Output Only] The status of this managed instance group. 379 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 380 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 381 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 382 }, 383 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 384 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 385 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 386 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 387 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 388 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 389 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 390 }, 391 }, 392 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 393 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 394 }, 395 }, 396 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 397 "A String", 398 ], 399 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 400 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 401 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 402 "updatePolicy": { # The update policy for this managed instance group. 403 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 404 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 405 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 406 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 407 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 408 }, 409 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 410 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 411 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 412 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 413 }, 414 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 415 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 416 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 417 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 418 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 419 }, 420 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 421 { 422 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 423 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 424 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 425 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 426 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 427 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 428 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 429 }, 430 }, 431 ], 432 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 433 }, 434 ], 435 "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty. 436 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 437 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 438 { 439 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 440 "value": "A String", # [Output Only] A warning data value corresponding to the key. 441 }, 442 ], 443 "message": "A String", # [Output Only] A human-readable description of the warning code. 444 }, 445 }, 446 }, 447 "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. 448 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 449 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 450 "unreachables": [ # [Output Only] Unreachable resources. 451 "A String", 452 ], 453 "warning": { # [Output Only] Informational warning message. 454 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 455 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 456 { 457 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 458 "value": "A String", # [Output Only] A warning data value corresponding to the key. 459 }, 460 ], 461 "message": "A String", # [Output Only] A human-readable description of the warning code. 462 }, 463}</pre> 464</div> 465 466<div class="method"> 467 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 468 <pre>Retrieves the next page of results. 469 470Args: 471 previous_request: The request for the previous page. (required) 472 previous_response: The response from the request for the previous page. (required) 473 474Returns: 475 A request object that you can call 'execute()' on to request the next 476 page. Returns None if there are no more items in the collection. 477 </pre> 478</div> 479 480<div class="method"> 481 <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None, x__xgafv=None)</code> 482 <pre>Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. 483 484Args: 485 project: string, Project ID for this request. (required) 486 zone: string, The name of the zone where the managed instance group is located. Should conform to RFC1035. (required) 487 instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required) 488 body: object, The request body. 489 The object takes the form of: 490 491{ # InstanceGroupManagers.applyUpdatesToInstances 492 "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request. 493 "instances": [ # The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 494 "A String", 495 ], 496 "maximalAction": "A String", # The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action. 497 "minimalAction": "A String", # The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. 498 "mostDisruptiveAllowedAction": "A String", # The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. 499} 500 501 x__xgafv: string, V1 error format. 502 Allowed values 503 1 - v1 error format 504 2 - v2 error format 505 506Returns: 507 An object of the form: 508 509 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 510 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 511 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 512 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 513 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 514 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 515 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 516 { 517 "code": "A String", # [Output Only] The error type identifier for this error. 518 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 519 "message": "A String", # [Output Only] An optional, human-readable error message. 520 }, 521 ], 522 }, 523 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 524 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 525 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 526 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 527 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 528 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 529 "a_key": "", # Properties of the object. Contains field @type with type URL. 530 }, 531 "name": "A String", # [Output Only] Name of the operation. 532 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 533 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 534 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 535 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 536 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 537 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 538 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 539 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 540 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 541 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 542 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 543 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 544 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 545 { 546 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 547 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 548 { 549 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 550 "value": "A String", # [Output Only] A warning data value corresponding to the key. 551 }, 552 ], 553 "message": "A String", # [Output Only] A human-readable description of the warning code. 554 }, 555 ], 556 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 557}</pre> 558</div> 559 560<div class="method"> 561 <code class="details" id="close">close()</code> 562 <pre>Close httplib2 connections.</pre> 563</div> 564 565<div class="method"> 566 <code class="details" id="createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 567 <pre>Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. 568 569Args: 570 project: string, Project ID for this request. (required) 571 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 572 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 573 body: object, The request body. 574 The object takes the form of: 575 576{ # InstanceGroupManagers.createInstances 577 "instances": [ # [Required] List of specifications of per-instance configs. 578 { 579 "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. 580 "name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error. 581 "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. 582 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 583 "a_key": { 584 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 585 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 586 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 587 }, 588 }, 589 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 590 "a_key": { 591 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 592 "ipAddress": { # Ip address representation 593 "address": "A String", # The URL of the reservation for this IP address. 594 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 595 }, 596 }, 597 }, 598 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 599 "a_key": { 600 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 601 "ipAddress": { # Ip address representation 602 "address": "A String", # The URL of the reservation for this IP address. 603 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 604 }, 605 }, 606 }, 607 "metadata": { # Preserved metadata defined for this instance. 608 "a_key": "A String", 609 }, 610 }, 611 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 612 }, 613 ], 614} 615 616 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 617 x__xgafv: string, V1 error format. 618 Allowed values 619 1 - v1 error format 620 2 - v2 error format 621 622Returns: 623 An object of the form: 624 625 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 626 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 627 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 628 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 629 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 630 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 631 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 632 { 633 "code": "A String", # [Output Only] The error type identifier for this error. 634 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 635 "message": "A String", # [Output Only] An optional, human-readable error message. 636 }, 637 ], 638 }, 639 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 640 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 641 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 642 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 643 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 644 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 645 "a_key": "", # Properties of the object. Contains field @type with type URL. 646 }, 647 "name": "A String", # [Output Only] Name of the operation. 648 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 649 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 650 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 651 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 652 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 653 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 654 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 655 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 656 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 657 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 658 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 659 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 660 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 661 { 662 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 663 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 664 { 665 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 666 "value": "A String", # [Output Only] A warning data value corresponding to the key. 667 }, 668 ], 669 "message": "A String", # [Output Only] A human-readable description of the warning code. 670 }, 671 ], 672 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 673}</pre> 674</div> 675 676<div class="method"> 677 <code class="details" id="delete">delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None)</code> 678 <pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. 679 680Args: 681 project: string, Project ID for this request. (required) 682 zone: string, The name of the zone where the managed instance group is located. (required) 683 instanceGroupManager: string, The name of the managed instance group to delete. (required) 684 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 685 x__xgafv: string, V1 error format. 686 Allowed values 687 1 - v1 error format 688 2 - v2 error format 689 690Returns: 691 An object of the form: 692 693 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 694 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 695 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 696 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 697 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 698 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 699 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 700 { 701 "code": "A String", # [Output Only] The error type identifier for this error. 702 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 703 "message": "A String", # [Output Only] An optional, human-readable error message. 704 }, 705 ], 706 }, 707 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 708 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 709 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 710 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 711 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 712 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 713 "a_key": "", # Properties of the object. Contains field @type with type URL. 714 }, 715 "name": "A String", # [Output Only] Name of the operation. 716 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 717 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 718 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 719 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 720 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 721 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 722 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 723 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 724 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 725 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 726 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 727 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 728 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 729 { 730 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 731 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 732 { 733 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 734 "value": "A String", # [Output Only] A warning data value corresponding to the key. 735 }, 736 ], 737 "message": "A String", # [Output Only] A human-readable description of the warning code. 738 }, 739 ], 740 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 741}</pre> 742</div> 743 744<div class="method"> 745 <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 746 <pre>Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. 747 748Args: 749 project: string, Project ID for this request. (required) 750 zone: string, The name of the zone where the managed instance group is located. (required) 751 instanceGroupManager: string, The name of the managed instance group. (required) 752 body: object, The request body. 753 The object takes the form of: 754 755{ 756 "instances": [ # The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 757 "A String", 758 ], 759 "skipInstancesOnValidationError": True or False, # Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region. 760} 761 762 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 763 x__xgafv: string, V1 error format. 764 Allowed values 765 1 - v1 error format 766 2 - v2 error format 767 768Returns: 769 An object of the form: 770 771 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 772 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 773 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 774 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 775 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 776 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 777 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 778 { 779 "code": "A String", # [Output Only] The error type identifier for this error. 780 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 781 "message": "A String", # [Output Only] An optional, human-readable error message. 782 }, 783 ], 784 }, 785 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 786 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 787 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 788 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 789 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 790 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 791 "a_key": "", # Properties of the object. Contains field @type with type URL. 792 }, 793 "name": "A String", # [Output Only] Name of the operation. 794 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 795 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 796 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 797 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 798 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 799 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 800 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 801 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 802 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 803 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 804 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 805 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 806 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 807 { 808 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 809 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 810 { 811 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 812 "value": "A String", # [Output Only] A warning data value corresponding to the key. 813 }, 814 ], 815 "message": "A String", # [Output Only] A human-readable description of the warning code. 816 }, 817 ], 818 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 819}</pre> 820</div> 821 822<div class="method"> 823 <code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None, x__xgafv=None)</code> 824 <pre>Deletes selected per-instance configs for the managed instance group. 825 826Args: 827 project: string, Project ID for this request. (required) 828 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 829 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 830 body: object, The request body. 831 The object takes the form of: 832 833{ # InstanceGroupManagers.deletePerInstanceConfigs 834 "names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group. 835 "A String", 836 ], 837} 838 839 x__xgafv: string, V1 error format. 840 Allowed values 841 1 - v1 error format 842 2 - v2 error format 843 844Returns: 845 An object of the form: 846 847 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 848 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 849 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 850 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 851 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 852 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 853 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 854 { 855 "code": "A String", # [Output Only] The error type identifier for this error. 856 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 857 "message": "A String", # [Output Only] An optional, human-readable error message. 858 }, 859 ], 860 }, 861 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 862 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 863 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 864 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 865 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 866 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 867 "a_key": "", # Properties of the object. Contains field @type with type URL. 868 }, 869 "name": "A String", # [Output Only] Name of the operation. 870 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 871 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 872 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 873 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 874 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 875 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 876 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 877 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 878 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 879 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 880 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 881 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 882 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 883 { 884 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 885 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 886 { 887 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 888 "value": "A String", # [Output Only] A warning data value corresponding to the key. 889 }, 890 ], 891 "message": "A String", # [Output Only] A human-readable description of the warning code. 892 }, 893 ], 894 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 895}</pre> 896</div> 897 898<div class="method"> 899 <code class="details" id="get">get(project, zone, instanceGroupManager, x__xgafv=None)</code> 900 <pre>Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. 901 902Args: 903 project: string, Project ID for this request. (required) 904 zone: string, The name of the zone where the managed instance group is located. (required) 905 instanceGroupManager: string, The name of the managed instance group. (required) 906 x__xgafv: string, V1 error format. 907 Allowed values 908 1 - v1 error format 909 2 - v2 error format 910 911Returns: 912 An object of the form: 913 914 { # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 915 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 916 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 917 "labels": { # The label key-value pairs that you want to patch onto the instance. 918 "a_key": "A String", 919 }, 920 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 921 "a_key": "A String", 922 }, 923 }, 924 }, 925 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 926 { 927 "autoHealingTriggers": { # Restricts what triggers autohealing. 928 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 929 }, 930 "healthCheck": "A String", # The URL for the health check that signals autohealing. 931 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 932 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 933 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 934 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 935 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 936 }, 937 "updateInstances": "A String", 938 }, 939 ], 940 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 941 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 942 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 943 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 944 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 945 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 946 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 947 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 948 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 949 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 950 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 951 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 952 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 953 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 954 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 955 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 956 }, 957 "description": "A String", # An optional description of this resource. 958 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 959 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 960 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 961 { 962 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 963 }, 964 ], 965 }, 966 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 967 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 968 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 969 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 970 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 971 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 972 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 973 }, 974 }, 975 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 976 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 977 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 978 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 979 { # The named port. For example: <"http", 80>. 980 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 981 "port": 42, # The port number, which can be a value between 1 and 65535. 982 }, 983 ], 984 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 985 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 986 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 987 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 988 "standbyPolicy": { # Standby policy for stopped and suspended instances. 989 "initialDelaySec": 42, 990 }, 991 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 992 "preservedState": { # Configuration of preserved resources. 993 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 994 "a_key": { 995 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 996 }, 997 }, 998 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 999 "a_key": { 1000 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1001 }, 1002 }, 1003 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1004 "a_key": { 1005 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1006 }, 1007 }, 1008 }, 1009 }, 1010 "status": { # [Output Only] The status of this managed instance group. 1011 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 1012 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 1013 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 1014 }, 1015 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1016 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 1017 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1018 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 1019 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 1020 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1021 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 1022 }, 1023 }, 1024 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1025 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 1026 }, 1027 }, 1028 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 1029 "A String", 1030 ], 1031 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 1032 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 1033 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 1034 "updatePolicy": { # The update policy for this managed instance group. 1035 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 1036 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 1037 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1038 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1039 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1040 }, 1041 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 1042 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1043 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1044 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1045 }, 1046 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1047 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 1048 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 1049 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1050 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 1051 }, 1052 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 1053 { 1054 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 1055 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1056 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 1057 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 1058 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1059 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1060 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1061 }, 1062 }, 1063 ], 1064 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1065}</pre> 1066</div> 1067 1068<div class="method"> 1069 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code> 1070 <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. 1071 1072Args: 1073 project: string, Project ID for this request. (required) 1074 zone: string, The name of the zone where you want to create the managed instance group. (required) 1075 body: object, The request body. 1076 The object takes the form of: 1077 1078{ # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 1079 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 1080 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 1081 "labels": { # The label key-value pairs that you want to patch onto the instance. 1082 "a_key": "A String", 1083 }, 1084 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 1085 "a_key": "A String", 1086 }, 1087 }, 1088 }, 1089 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1090 { 1091 "autoHealingTriggers": { # Restricts what triggers autohealing. 1092 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 1093 }, 1094 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1095 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 1096 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 1097 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1098 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1099 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1100 }, 1101 "updateInstances": "A String", 1102 }, 1103 ], 1104 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 1105 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1106 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 1107 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 1108 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 1109 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 1110 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1111 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1112 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 1113 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 1114 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1115 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 1116 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 1117 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 1118 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 1119 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 1120 }, 1121 "description": "A String", # An optional description of this resource. 1122 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 1123 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 1124 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 1125 { 1126 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 1127 }, 1128 ], 1129 }, 1130 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 1131 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 1132 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1133 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1134 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 1135 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 1136 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 1137 }, 1138 }, 1139 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 1140 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1141 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1142 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1143 { # The named port. For example: <"http", 80>. 1144 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1145 "port": 42, # The port number, which can be a value between 1 and 65535. 1146 }, 1147 ], 1148 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1149 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1150 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1151 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 1152 "standbyPolicy": { # Standby policy for stopped and suspended instances. 1153 "initialDelaySec": 42, 1154 }, 1155 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1156 "preservedState": { # Configuration of preserved resources. 1157 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 1158 "a_key": { 1159 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1160 }, 1161 }, 1162 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1163 "a_key": { 1164 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1165 }, 1166 }, 1167 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1168 "a_key": { 1169 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1170 }, 1171 }, 1172 }, 1173 }, 1174 "status": { # [Output Only] The status of this managed instance group. 1175 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 1176 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 1177 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 1178 }, 1179 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1180 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 1181 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1182 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 1183 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 1184 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1185 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 1186 }, 1187 }, 1188 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1189 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 1190 }, 1191 }, 1192 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 1193 "A String", 1194 ], 1195 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 1196 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 1197 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 1198 "updatePolicy": { # The update policy for this managed instance group. 1199 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 1200 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 1201 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1202 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1203 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1204 }, 1205 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 1206 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1207 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1208 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1209 }, 1210 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1211 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 1212 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 1213 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1214 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 1215 }, 1216 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 1217 { 1218 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 1219 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1220 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 1221 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 1222 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1223 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1224 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1225 }, 1226 }, 1227 ], 1228 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1229} 1230 1231 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1232 x__xgafv: string, V1 error format. 1233 Allowed values 1234 1 - v1 error format 1235 2 - v2 error format 1236 1237Returns: 1238 An object of the form: 1239 1240 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1241 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1242 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1243 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1244 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1245 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1246 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1247 { 1248 "code": "A String", # [Output Only] The error type identifier for this error. 1249 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1250 "message": "A String", # [Output Only] An optional, human-readable error message. 1251 }, 1252 ], 1253 }, 1254 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1255 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 1256 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1257 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1258 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1259 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1260 "a_key": "", # Properties of the object. Contains field @type with type URL. 1261 }, 1262 "name": "A String", # [Output Only] Name of the operation. 1263 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1264 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1265 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1266 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1267 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1268 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1269 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1270 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1271 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1272 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1273 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1274 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1275 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1276 { 1277 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1278 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1279 { 1280 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1281 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1282 }, 1283 ], 1284 "message": "A String", # [Output Only] A human-readable description of the warning code. 1285 }, 1286 ], 1287 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1288}</pre> 1289</div> 1290 1291<div class="method"> 1292 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1293 <pre>Retrieves a list of managed instance groups that are contained within the specified project and zone. 1294 1295Args: 1296 project: string, Project ID for this request. (required) 1297 zone: string, The name of the zone where the managed instance group is located. (required) 1298 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 1299 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 1300 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 1301 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 1302 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1303 x__xgafv: string, V1 error format. 1304 Allowed values 1305 1 - v1 error format 1306 2 - v2 error format 1307 1308Returns: 1309 An object of the form: 1310 1311 { # [Output Only] A list of managed instance groups. 1312 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1313 "items": [ # A list of InstanceGroupManager resources. 1314 { # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 1315 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 1316 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 1317 "labels": { # The label key-value pairs that you want to patch onto the instance. 1318 "a_key": "A String", 1319 }, 1320 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 1321 "a_key": "A String", 1322 }, 1323 }, 1324 }, 1325 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1326 { 1327 "autoHealingTriggers": { # Restricts what triggers autohealing. 1328 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 1329 }, 1330 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1331 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 1332 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 1333 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1334 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1335 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1336 }, 1337 "updateInstances": "A String", 1338 }, 1339 ], 1340 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 1341 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1342 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 1343 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 1344 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 1345 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 1346 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1347 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1348 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 1349 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 1350 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1351 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 1352 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 1353 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 1354 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 1355 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 1356 }, 1357 "description": "A String", # An optional description of this resource. 1358 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 1359 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 1360 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 1361 { 1362 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 1363 }, 1364 ], 1365 }, 1366 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 1367 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 1368 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1369 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1370 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 1371 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 1372 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 1373 }, 1374 }, 1375 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 1376 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1377 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1378 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1379 { # The named port. For example: <"http", 80>. 1380 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1381 "port": 42, # The port number, which can be a value between 1 and 65535. 1382 }, 1383 ], 1384 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1385 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1386 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1387 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 1388 "standbyPolicy": { # Standby policy for stopped and suspended instances. 1389 "initialDelaySec": 42, 1390 }, 1391 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1392 "preservedState": { # Configuration of preserved resources. 1393 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 1394 "a_key": { 1395 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1396 }, 1397 }, 1398 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1399 "a_key": { 1400 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1401 }, 1402 }, 1403 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1404 "a_key": { 1405 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1406 }, 1407 }, 1408 }, 1409 }, 1410 "status": { # [Output Only] The status of this managed instance group. 1411 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 1412 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 1413 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 1414 }, 1415 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1416 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 1417 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1418 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 1419 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 1420 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1421 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 1422 }, 1423 }, 1424 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1425 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 1426 }, 1427 }, 1428 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 1429 "A String", 1430 ], 1431 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 1432 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 1433 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 1434 "updatePolicy": { # The update policy for this managed instance group. 1435 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 1436 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 1437 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1438 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1439 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1440 }, 1441 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 1442 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1443 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1444 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1445 }, 1446 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1447 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 1448 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 1449 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1450 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 1451 }, 1452 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 1453 { 1454 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 1455 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1456 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 1457 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 1458 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1459 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1460 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1461 }, 1462 }, 1463 ], 1464 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1465 }, 1466 ], 1467 "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. 1468 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 1469 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1470 "warning": { # [Output Only] Informational warning message. 1471 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1472 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1473 { 1474 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1475 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1476 }, 1477 ], 1478 "message": "A String", # [Output Only] A human-readable description of the warning code. 1479 }, 1480}</pre> 1481</div> 1482 1483<div class="method"> 1484 <code class="details" id="listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1485 <pre>Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported. 1486 1487Args: 1488 project: string, Project ID for this request. (required) 1489 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 1490 instanceGroupManager: string, The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. (required) 1491 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 1492 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 1493 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 1494 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 1495 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1496 x__xgafv: string, V1 error format. 1497 Allowed values 1498 1 - v1 error format 1499 2 - v2 error format 1500 1501Returns: 1502 An object of the form: 1503 1504 { 1505 "items": [ # [Output Only] The list of errors of the managed instance group. 1506 { 1507 "error": { # [Output Only] Contents of the error. 1508 "code": "A String", # [Output Only] Error code. 1509 "message": "A String", # [Output Only] Error message. 1510 }, 1511 "instanceActionDetails": { # [Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional. 1512 "action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: 1513 "instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created. 1514 "version": { # [Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created. 1515 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1516 "name": "A String", # [Output Only] Name of the version. 1517 }, 1518 }, 1519 "timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format. 1520 }, 1521 ], 1522 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 1523}</pre> 1524</div> 1525 1526<div class="method"> 1527 <code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code> 1528 <pre>Retrieves the next page of results. 1529 1530Args: 1531 previous_request: The request for the previous page. (required) 1532 previous_response: The response from the request for the previous page. (required) 1533 1534Returns: 1535 A request object that you can call 'execute()' on to request the next 1536 page. Returns None if there are no more items in the collection. 1537 </pre> 1538</div> 1539 1540<div class="method"> 1541 <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1542 <pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. 1543 1544Args: 1545 project: string, Project ID for this request. (required) 1546 zone: string, The name of the zone where the managed instance group is located. (required) 1547 instanceGroupManager: string, The name of the managed instance group. (required) 1548 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 1549 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 1550 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 1551 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 1552 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1553 x__xgafv: string, V1 error format. 1554 Allowed values 1555 1 - v1 error format 1556 2 - v2 error format 1557 1558Returns: 1559 An object of the form: 1560 1561 { 1562 "managedInstances": [ # [Output Only] The list of instances in the managed instance group. 1563 { # A Managed Instance resource. 1564 "allInstancesConfig": { # [Output Only] Instances config revision applied to this instance. 1565 "revision": "A String", # [Output Only] Instances config revision. This value is in RFC3339 text format. 1566 }, 1567 "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. 1568 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist. 1569 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. 1570 "instanceHealth": [ # [Output Only] Health state of the instance per health-check. 1571 { 1572 "detailedHealthState": "A String", # [Output Only] The current detailed instance health state. 1573 "healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy. 1574 "healthState": "A String", # [Output Only] The current instance health state. This field will not get promoted to beta/GA and might be removed from alpha APIs after 01/12/2019. Please use detailed_health_state field instead. 1575 }, 1576 ], 1577 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist. 1578 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1579 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance. 1580 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance. 1581 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1582 { 1583 "code": "A String", # [Output Only] The error type identifier for this error. 1584 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1585 "message": "A String", # [Output Only] An optional, human-readable error message. 1586 }, 1587 ], 1588 }, 1589 }, 1590 "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance. 1591 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1592 "a_key": { 1593 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1594 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 1595 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1596 }, 1597 }, 1598 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1599 "a_key": { 1600 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1601 "ipAddress": { # Ip address representation 1602 "address": "A String", # The URL of the reservation for this IP address. 1603 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1604 }, 1605 }, 1606 }, 1607 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1608 "a_key": { 1609 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1610 "ipAddress": { # Ip address representation 1611 "address": "A String", # The URL of the reservation for this IP address. 1612 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1613 }, 1614 }, 1615 }, 1616 "metadata": { # Preserved metadata defined for this instance. 1617 "a_key": "A String", 1618 }, 1619 }, 1620 "preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy for this instance. 1621 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1622 "a_key": { 1623 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1624 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 1625 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1626 }, 1627 }, 1628 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1629 "a_key": { 1630 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1631 "ipAddress": { # Ip address representation 1632 "address": "A String", # The URL of the reservation for this IP address. 1633 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1634 }, 1635 }, 1636 }, 1637 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1638 "a_key": { 1639 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1640 "ipAddress": { # Ip address representation 1641 "address": "A String", # The URL of the reservation for this IP address. 1642 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1643 }, 1644 }, 1645 }, 1646 "metadata": { # Preserved metadata defined for this instance. 1647 "a_key": "A String", 1648 }, 1649 }, 1650 "tag": "A String", # [Output Only] Tag describing the version. 1651 "targetStatus": "A String", # [Output Only] The eventual status of the instance. The instance group manager will not be identified as stable till each managed instance reaches its targetStatus. 1652 "version": { # [Output Only] Intended version of this instance. 1653 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1654 "name": "A String", # [Output Only] Name of the version. 1655 }, 1656 }, 1657 ], 1658 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 1659}</pre> 1660</div> 1661 1662<div class="method"> 1663 <code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code> 1664 <pre>Retrieves the next page of results. 1665 1666Args: 1667 previous_request: The request for the previous page. (required) 1668 previous_response: The response from the request for the previous page. (required) 1669 1670Returns: 1671 A request object that you can call 'execute()' on to request the next 1672 page. Returns None if there are no more items in the collection. 1673 </pre> 1674</div> 1675 1676<div class="method"> 1677 <code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1678 <pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported. 1679 1680Args: 1681 project: string, Project ID for this request. (required) 1682 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 1683 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1684 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 1685 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 1686 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 1687 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 1688 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1689 x__xgafv: string, V1 error format. 1690 Allowed values 1691 1 - v1 error format 1692 2 - v2 error format 1693 1694Returns: 1695 An object of the form: 1696 1697 { 1698 "items": [ # [Output Only] The list of PerInstanceConfig. 1699 { 1700 "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. 1701 "name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error. 1702 "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. 1703 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1704 "a_key": { 1705 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1706 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 1707 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1708 }, 1709 }, 1710 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1711 "a_key": { 1712 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1713 "ipAddress": { # Ip address representation 1714 "address": "A String", # The URL of the reservation for this IP address. 1715 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1716 }, 1717 }, 1718 }, 1719 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1720 "a_key": { 1721 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1722 "ipAddress": { # Ip address representation 1723 "address": "A String", # The URL of the reservation for this IP address. 1724 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1725 }, 1726 }, 1727 }, 1728 "metadata": { # Preserved metadata defined for this instance. 1729 "a_key": "A String", 1730 }, 1731 }, 1732 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1733 }, 1734 ], 1735 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 1736 "warning": { # [Output Only] Informational warning message. 1737 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1738 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1739 { 1740 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1741 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1742 }, 1743 ], 1744 "message": "A String", # [Output Only] A human-readable description of the warning code. 1745 }, 1746}</pre> 1747</div> 1748 1749<div class="method"> 1750 <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code> 1751 <pre>Retrieves the next page of results. 1752 1753Args: 1754 previous_request: The request for the previous page. (required) 1755 previous_response: The response from the request for the previous page. (required) 1756 1757Returns: 1758 A request object that you can call 'execute()' on to request the next 1759 page. Returns None if there are no more items in the collection. 1760 </pre> 1761</div> 1762 1763<div class="method"> 1764 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1765 <pre>Retrieves the next page of results. 1766 1767Args: 1768 previous_request: The request for the previous page. (required) 1769 previous_response: The response from the request for the previous page. (required) 1770 1771Returns: 1772 A request object that you can call 'execute()' on to request the next 1773 page. Returns None if there are no more items in the collection. 1774 </pre> 1775</div> 1776 1777<div class="method"> 1778 <code class="details" id="patch">patch(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1779 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. 1780 1781Args: 1782 project: string, Project ID for this request. (required) 1783 zone: string, The name of the zone where you want to create the managed instance group. (required) 1784 instanceGroupManager: string, The name of the instance group manager. (required) 1785 body: object, The request body. 1786 The object takes the form of: 1787 1788{ # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 1789 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 1790 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 1791 "labels": { # The label key-value pairs that you want to patch onto the instance. 1792 "a_key": "A String", 1793 }, 1794 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 1795 "a_key": "A String", 1796 }, 1797 }, 1798 }, 1799 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1800 { 1801 "autoHealingTriggers": { # Restricts what triggers autohealing. 1802 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 1803 }, 1804 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1805 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 1806 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 1807 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1808 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1809 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1810 }, 1811 "updateInstances": "A String", 1812 }, 1813 ], 1814 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 1815 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1816 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 1817 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 1818 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 1819 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 1820 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1821 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1822 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 1823 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 1824 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1825 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 1826 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 1827 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 1828 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 1829 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 1830 }, 1831 "description": "A String", # An optional description of this resource. 1832 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 1833 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 1834 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 1835 { 1836 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 1837 }, 1838 ], 1839 }, 1840 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 1841 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 1842 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1843 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1844 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 1845 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 1846 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 1847 }, 1848 }, 1849 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 1850 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1851 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1852 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1853 { # The named port. For example: <"http", 80>. 1854 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1855 "port": 42, # The port number, which can be a value between 1 and 65535. 1856 }, 1857 ], 1858 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1859 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1860 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1861 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 1862 "standbyPolicy": { # Standby policy for stopped and suspended instances. 1863 "initialDelaySec": 42, 1864 }, 1865 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1866 "preservedState": { # Configuration of preserved resources. 1867 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 1868 "a_key": { 1869 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 1870 }, 1871 }, 1872 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1873 "a_key": { 1874 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1875 }, 1876 }, 1877 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 1878 "a_key": { 1879 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 1880 }, 1881 }, 1882 }, 1883 }, 1884 "status": { # [Output Only] The status of this managed instance group. 1885 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 1886 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 1887 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 1888 }, 1889 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1890 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 1891 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1892 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 1893 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 1894 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1895 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 1896 }, 1897 }, 1898 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1899 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 1900 }, 1901 }, 1902 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 1903 "A String", 1904 ], 1905 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 1906 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 1907 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 1908 "updatePolicy": { # The update policy for this managed instance group. 1909 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 1910 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 1911 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1912 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1913 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1914 }, 1915 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 1916 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1917 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1918 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1919 }, 1920 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1921 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 1922 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 1923 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1924 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 1925 }, 1926 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 1927 { 1928 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 1929 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1930 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 1931 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 1932 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 1933 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1934 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1935 }, 1936 }, 1937 ], 1938 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1939} 1940 1941 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1942 x__xgafv: string, V1 error format. 1943 Allowed values 1944 1 - v1 error format 1945 2 - v2 error format 1946 1947Returns: 1948 An object of the form: 1949 1950 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1951 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1952 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1953 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1954 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1955 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1956 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1957 { 1958 "code": "A String", # [Output Only] The error type identifier for this error. 1959 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1960 "message": "A String", # [Output Only] An optional, human-readable error message. 1961 }, 1962 ], 1963 }, 1964 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1965 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 1966 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1967 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1968 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1969 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1970 "a_key": "", # Properties of the object. Contains field @type with type URL. 1971 }, 1972 "name": "A String", # [Output Only] Name of the operation. 1973 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1974 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1975 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1976 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1977 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1978 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1979 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1980 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1981 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1982 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1983 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1984 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1985 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1986 { 1987 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1988 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1989 { 1990 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1991 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1992 }, 1993 ], 1994 "message": "A String", # [Output Only] A human-readable description of the warning code. 1995 }, 1996 ], 1997 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1998}</pre> 1999</div> 2000 2001<div class="method"> 2002 <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2003 <pre>Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. 2004 2005Args: 2006 project: string, Project ID for this request. (required) 2007 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 2008 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 2009 body: object, The request body. 2010 The object takes the form of: 2011 2012{ # InstanceGroupManagers.patchPerInstanceConfigs 2013 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 2014 { 2015 "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. 2016 "name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error. 2017 "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. 2018 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 2019 "a_key": { 2020 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 2021 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 2022 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 2023 }, 2024 }, 2025 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 2026 "a_key": { 2027 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 2028 "ipAddress": { # Ip address representation 2029 "address": "A String", # The URL of the reservation for this IP address. 2030 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 2031 }, 2032 }, 2033 }, 2034 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 2035 "a_key": { 2036 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 2037 "ipAddress": { # Ip address representation 2038 "address": "A String", # The URL of the reservation for this IP address. 2039 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 2040 }, 2041 }, 2042 }, 2043 "metadata": { # Preserved metadata defined for this instance. 2044 "a_key": "A String", 2045 }, 2046 }, 2047 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 2048 }, 2049 ], 2050} 2051 2052 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2053 x__xgafv: string, V1 error format. 2054 Allowed values 2055 1 - v1 error format 2056 2 - v2 error format 2057 2058Returns: 2059 An object of the form: 2060 2061 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2062 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2063 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2064 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2065 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2066 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2067 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2068 { 2069 "code": "A String", # [Output Only] The error type identifier for this error. 2070 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2071 "message": "A String", # [Output Only] An optional, human-readable error message. 2072 }, 2073 ], 2074 }, 2075 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2076 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2077 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2078 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2079 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2080 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2081 "a_key": "", # Properties of the object. Contains field @type with type URL. 2082 }, 2083 "name": "A String", # [Output Only] Name of the operation. 2084 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2085 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2086 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2087 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2088 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2089 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2090 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2091 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2092 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2093 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2094 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2095 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2096 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2097 { 2098 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2099 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2100 { 2101 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2102 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2103 }, 2104 ], 2105 "message": "A String", # [Output Only] A human-readable description of the warning code. 2106 }, 2107 ], 2108 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2109}</pre> 2110</div> 2111 2112<div class="method"> 2113 <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2114 <pre>Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. 2115 2116Args: 2117 project: string, Project ID for this request. (required) 2118 zone: string, The name of the zone where the managed instance group is located. (required) 2119 instanceGroupManager: string, The name of the managed instance group. (required) 2120 body: object, The request body. 2121 The object takes the form of: 2122 2123{ 2124 "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 2125 "A String", 2126 ], 2127} 2128 2129 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2130 x__xgafv: string, V1 error format. 2131 Allowed values 2132 1 - v1 error format 2133 2 - v2 error format 2134 2135Returns: 2136 An object of the form: 2137 2138 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2139 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2140 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2142 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2143 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2144 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2145 { 2146 "code": "A String", # [Output Only] The error type identifier for this error. 2147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2148 "message": "A String", # [Output Only] An optional, human-readable error message. 2149 }, 2150 ], 2151 }, 2152 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2153 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2154 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2155 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2156 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2157 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2158 "a_key": "", # Properties of the object. Contains field @type with type URL. 2159 }, 2160 "name": "A String", # [Output Only] Name of the operation. 2161 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2162 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2163 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2164 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2166 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2167 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2168 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2169 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2170 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2171 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2172 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2173 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2174 { 2175 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2176 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2177 { 2178 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2179 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2180 }, 2181 ], 2182 "message": "A String", # [Output Only] A human-readable description of the warning code. 2183 }, 2184 ], 2185 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2186}</pre> 2187</div> 2188 2189<div class="method"> 2190 <code class="details" id="resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</code> 2191 <pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. 2192 2193Args: 2194 project: string, Project ID for this request. (required) 2195 zone: string, The name of the zone where the managed instance group is located. (required) 2196 instanceGroupManager: string, The name of the managed instance group. (required) 2197 size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required) 2198 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2199 x__xgafv: string, V1 error format. 2200 Allowed values 2201 1 - v1 error format 2202 2 - v2 error format 2203 2204Returns: 2205 An object of the form: 2206 2207 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2208 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2209 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2210 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2211 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2212 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2213 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2214 { 2215 "code": "A String", # [Output Only] The error type identifier for this error. 2216 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2217 "message": "A String", # [Output Only] An optional, human-readable error message. 2218 }, 2219 ], 2220 }, 2221 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2222 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2223 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2224 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2225 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2226 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2227 "a_key": "", # Properties of the object. Contains field @type with type URL. 2228 }, 2229 "name": "A String", # [Output Only] Name of the operation. 2230 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2231 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2232 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2233 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2234 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2235 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2236 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2237 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2238 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2239 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2240 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2241 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2242 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2243 { 2244 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2245 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2246 { 2247 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2248 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2249 }, 2250 ], 2251 "message": "A String", # [Output Only] A human-readable description of the warning code. 2252 }, 2253 ], 2254 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2255}</pre> 2256</div> 2257 2258<div class="method"> 2259 <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2260 <pre>Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. 2261 2262Args: 2263 project: string, Project ID for this request. (required) 2264 zone: string, The name of the zone where the managed instance group is located. (required) 2265 instanceGroupManager: string, The name of the managed instance group. (required) 2266 body: object, The request body. 2267 The object takes the form of: 2268 2269{ 2270 "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API. 2271 "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. 2272} 2273 2274 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2275 x__xgafv: string, V1 error format. 2276 Allowed values 2277 1 - v1 error format 2278 2 - v2 error format 2279 2280Returns: 2281 An object of the form: 2282 2283 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2284 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2285 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2286 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2287 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2288 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2289 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2290 { 2291 "code": "A String", # [Output Only] The error type identifier for this error. 2292 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2293 "message": "A String", # [Output Only] An optional, human-readable error message. 2294 }, 2295 ], 2296 }, 2297 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2298 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2299 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2300 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2301 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2302 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2303 "a_key": "", # Properties of the object. Contains field @type with type URL. 2304 }, 2305 "name": "A String", # [Output Only] Name of the operation. 2306 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2307 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2308 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2309 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2310 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2311 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2312 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2313 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2314 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2315 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2316 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2317 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2318 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2319 { 2320 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2321 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2322 { 2323 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2324 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2325 }, 2326 ], 2327 "message": "A String", # [Output Only] A human-readable description of the warning code. 2328 }, 2329 ], 2330 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2331}</pre> 2332</div> 2333 2334<div class="method"> 2335 <code class="details" id="resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2336 <pre>Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. 2337 2338Args: 2339 project: string, Project ID for this request. (required) 2340 zone: string, The name of the zone where the managed instance group is located. (required) 2341 instanceGroupManager: string, The name of the managed instance group. (required) 2342 body: object, The request body. 2343 The object takes the form of: 2344 2345{ 2346 "instances": [ # The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 2347 "A String", 2348 ], 2349} 2350 2351 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2352 x__xgafv: string, V1 error format. 2353 Allowed values 2354 1 - v1 error format 2355 2 - v2 error format 2356 2357Returns: 2358 An object of the form: 2359 2360 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2361 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2362 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2363 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2364 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2365 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2366 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2367 { 2368 "code": "A String", # [Output Only] The error type identifier for this error. 2369 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2370 "message": "A String", # [Output Only] An optional, human-readable error message. 2371 }, 2372 ], 2373 }, 2374 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2375 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2376 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2377 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2378 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2379 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2380 "a_key": "", # Properties of the object. Contains field @type with type URL. 2381 }, 2382 "name": "A String", # [Output Only] Name of the operation. 2383 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2384 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2385 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2386 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2388 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2389 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2390 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2391 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2392 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2393 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2394 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2395 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2396 { 2397 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2398 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2399 { 2400 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2401 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2402 }, 2403 ], 2404 "message": "A String", # [Output Only] A human-readable description of the warning code. 2405 }, 2406 ], 2407 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2408}</pre> 2409</div> 2410 2411<div class="method"> 2412 <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2413 <pre>Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead. 2414 2415Args: 2416 project: string, Project ID for this request. (required) 2417 zone: string, The name of the zone where the managed instance group is located. (required) 2418 instanceGroupManager: string, The name of the instance group manager. (required) 2419 body: object, The request body. 2420 The object takes the form of: 2421 2422{ 2423 "autoHealingPolicies": [ 2424 { 2425 "autoHealingTriggers": { # Restricts what triggers autohealing. 2426 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 2427 }, 2428 "healthCheck": "A String", # The URL for the health check that signals autohealing. 2429 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 2430 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 2431 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 2432 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 2433 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 2434 }, 2435 "updateInstances": "A String", 2436 }, 2437 ], 2438} 2439 2440 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2441 x__xgafv: string, V1 error format. 2442 Allowed values 2443 1 - v1 error format 2444 2 - v2 error format 2445 2446Returns: 2447 An object of the form: 2448 2449 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2450 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2451 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2452 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2453 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2454 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2455 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2456 { 2457 "code": "A String", # [Output Only] The error type identifier for this error. 2458 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2459 "message": "A String", # [Output Only] An optional, human-readable error message. 2460 }, 2461 ], 2462 }, 2463 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2464 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2465 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2466 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2467 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2468 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2469 "a_key": "", # Properties of the object. Contains field @type with type URL. 2470 }, 2471 "name": "A String", # [Output Only] Name of the operation. 2472 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2473 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2474 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2475 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2476 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2477 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2478 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2479 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2480 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2481 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2482 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2483 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2484 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2485 { 2486 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2487 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2488 { 2489 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2490 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2491 }, 2492 ], 2493 "message": "A String", # [Output Only] A human-readable description of the warning code. 2494 }, 2495 ], 2496 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2497}</pre> 2498</div> 2499 2500<div class="method"> 2501 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2502 <pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 2503 2504Args: 2505 project: string, Project ID for this request. (required) 2506 zone: string, The name of the zone where the managed instance group is located. (required) 2507 instanceGroupManager: string, The name of the managed instance group. (required) 2508 body: object, The request body. 2509 The object takes the form of: 2510 2511{ 2512 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 2513} 2514 2515 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2516 x__xgafv: string, V1 error format. 2517 Allowed values 2518 1 - v1 error format 2519 2 - v2 error format 2520 2521Returns: 2522 An object of the form: 2523 2524 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2525 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2526 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2527 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2528 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2529 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2530 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2531 { 2532 "code": "A String", # [Output Only] The error type identifier for this error. 2533 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2534 "message": "A String", # [Output Only] An optional, human-readable error message. 2535 }, 2536 ], 2537 }, 2538 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2539 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2540 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2541 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2542 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2543 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2544 "a_key": "", # Properties of the object. Contains field @type with type URL. 2545 }, 2546 "name": "A String", # [Output Only] Name of the operation. 2547 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2548 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2549 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2550 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2551 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2552 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2553 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2554 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2555 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2556 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2557 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2558 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2559 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2560 { 2561 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2562 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2563 { 2564 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2565 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2566 }, 2567 ], 2568 "message": "A String", # [Output Only] A human-readable description of the warning code. 2569 }, 2570 ], 2571 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2572}</pre> 2573</div> 2574 2575<div class="method"> 2576 <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2577 <pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. 2578 2579Args: 2580 project: string, Project ID for this request. (required) 2581 zone: string, The name of the zone where the managed instance group is located. (required) 2582 instanceGroupManager: string, The name of the managed instance group. (required) 2583 body: object, The request body. 2584 The object takes the form of: 2585 2586{ 2587 "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. 2588 "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. 2589 "A String", 2590 ], 2591} 2592 2593 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2594 x__xgafv: string, V1 error format. 2595 Allowed values 2596 1 - v1 error format 2597 2 - v2 error format 2598 2599Returns: 2600 An object of the form: 2601 2602 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2603 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2604 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2605 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2606 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2607 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2608 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2609 { 2610 "code": "A String", # [Output Only] The error type identifier for this error. 2611 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2612 "message": "A String", # [Output Only] An optional, human-readable error message. 2613 }, 2614 ], 2615 }, 2616 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2617 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2618 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2619 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2620 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2621 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2622 "a_key": "", # Properties of the object. Contains field @type with type URL. 2623 }, 2624 "name": "A String", # [Output Only] Name of the operation. 2625 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2626 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2627 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2628 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2629 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2630 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2631 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2632 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2633 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2634 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2635 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2636 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2637 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2638 { 2639 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2640 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2641 { 2642 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2643 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2644 }, 2645 ], 2646 "message": "A String", # [Output Only] A human-readable description of the warning code. 2647 }, 2648 ], 2649 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2650}</pre> 2651</div> 2652 2653<div class="method"> 2654 <code class="details" id="startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2655 <pre>Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. 2656 2657Args: 2658 project: string, Project ID for this request. (required) 2659 zone: string, The name of the zone where the managed instance group is located. (required) 2660 instanceGroupManager: string, The name of the managed instance group. (required) 2661 body: object, The request body. 2662 The object takes the form of: 2663 2664{ 2665 "instances": [ # The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 2666 "A String", 2667 ], 2668} 2669 2670 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2671 x__xgafv: string, V1 error format. 2672 Allowed values 2673 1 - v1 error format 2674 2 - v2 error format 2675 2676Returns: 2677 An object of the form: 2678 2679 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2680 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2681 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2682 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2683 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2684 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2685 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2686 { 2687 "code": "A String", # [Output Only] The error type identifier for this error. 2688 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2689 "message": "A String", # [Output Only] An optional, human-readable error message. 2690 }, 2691 ], 2692 }, 2693 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2694 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2695 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2696 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2697 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2698 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2699 "a_key": "", # Properties of the object. Contains field @type with type URL. 2700 }, 2701 "name": "A String", # [Output Only] Name of the operation. 2702 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2703 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2704 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2705 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2706 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2707 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2708 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2709 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2710 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2711 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2712 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2713 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2714 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2715 { 2716 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2717 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2718 { 2719 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2720 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2721 }, 2722 ], 2723 "message": "A String", # [Output Only] A human-readable description of the warning code. 2724 }, 2725 ], 2726 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2727}</pre> 2728</div> 2729 2730<div class="method"> 2731 <code class="details" id="stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2732 <pre>Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. 2733 2734Args: 2735 project: string, Project ID for this request. (required) 2736 zone: string, The name of the zone where the managed instance group is located. (required) 2737 instanceGroupManager: string, The name of the managed instance group. (required) 2738 body: object, The request body. 2739 The object takes the form of: 2740 2741{ 2742 "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them. 2743 "instances": [ # The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 2744 "A String", 2745 ], 2746} 2747 2748 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2749 x__xgafv: string, V1 error format. 2750 Allowed values 2751 1 - v1 error format 2752 2 - v2 error format 2753 2754Returns: 2755 An object of the form: 2756 2757 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2758 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2759 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2760 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2761 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2762 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2763 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2764 { 2765 "code": "A String", # [Output Only] The error type identifier for this error. 2766 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2767 "message": "A String", # [Output Only] An optional, human-readable error message. 2768 }, 2769 ], 2770 }, 2771 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2772 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2773 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2774 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2775 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2776 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2777 "a_key": "", # Properties of the object. Contains field @type with type URL. 2778 }, 2779 "name": "A String", # [Output Only] Name of the operation. 2780 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2781 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2782 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2783 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2784 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2785 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2786 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2787 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2788 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2789 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2790 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2791 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2792 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2793 { 2794 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2795 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2796 { 2797 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2798 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2799 }, 2800 ], 2801 "message": "A String", # [Output Only] A human-readable description of the warning code. 2802 }, 2803 ], 2804 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2805}</pre> 2806</div> 2807 2808<div class="method"> 2809 <code class="details" id="suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2810 <pre>Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. 2811 2812Args: 2813 project: string, Project ID for this request. (required) 2814 zone: string, The name of the zone where the managed instance group is located. (required) 2815 instanceGroupManager: string, The name of the managed instance group. (required) 2816 body: object, The request body. 2817 The object takes the form of: 2818 2819{ 2820 "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them. 2821 "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. 2822 "A String", 2823 ], 2824} 2825 2826 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2827 x__xgafv: string, V1 error format. 2828 Allowed values 2829 1 - v1 error format 2830 2 - v2 error format 2831 2832Returns: 2833 An object of the form: 2834 2835 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2836 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2837 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2838 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2839 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2840 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2841 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2842 { 2843 "code": "A String", # [Output Only] The error type identifier for this error. 2844 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2845 "message": "A String", # [Output Only] An optional, human-readable error message. 2846 }, 2847 ], 2848 }, 2849 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2850 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 2851 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2852 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2853 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2854 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 2855 "a_key": "", # Properties of the object. Contains field @type with type URL. 2856 }, 2857 "name": "A String", # [Output Only] Name of the operation. 2858 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2859 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2860 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2861 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2862 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2863 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 2864 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2865 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2866 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2867 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2868 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2869 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2870 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2871 { 2872 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2873 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2874 { 2875 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2876 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2877 }, 2878 ], 2879 "message": "A String", # [Output Only] A human-readable description of the warning code. 2880 }, 2881 ], 2882 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2883}</pre> 2884</div> 2885 2886<div class="method"> 2887 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 2888 <pre>Returns permissions that a caller has on the specified resource. 2889 2890Args: 2891 project: string, Project ID for this request. (required) 2892 zone: string, The name of the zone for this request. (required) 2893 resource: string, Name or id of the resource for this request. (required) 2894 body: object, The request body. 2895 The object takes the form of: 2896 2897{ 2898 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 2899 "A String", 2900 ], 2901} 2902 2903 x__xgafv: string, V1 error format. 2904 Allowed values 2905 1 - v1 error format 2906 2 - v2 error format 2907 2908Returns: 2909 An object of the form: 2910 2911 { 2912 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 2913 "A String", 2914 ], 2915}</pre> 2916</div> 2917 2918<div class="method"> 2919 <code class="details" id="update">update(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2920 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. 2921 2922Args: 2923 project: string, Project ID for this request. (required) 2924 zone: string, The name of the zone where you want to create the managed instance group. (required) 2925 instanceGroupManager: string, The name of the instance group manager. (required) 2926 body: object, The request body. 2927 The object takes the form of: 2928 2929{ # Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. 2930 "allInstancesConfig": { # Specifies the instances configs overrides that should be applied for all instances in the MIG. 2931 "properties": { # Represents the change that you want to make to the instance properties. # Properties for instances that are created using this instances config. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting instances_config, you must update your instances to use it; for example, you can use the applyUpdatesToInstances method. 2932 "labels": { # The label key-value pairs that you want to patch onto the instance. 2933 "a_key": "A String", 2934 }, 2935 "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. 2936 "a_key": "A String", 2937 }, 2938 }, 2939 }, 2940 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 2941 { 2942 "autoHealingTriggers": { # Restricts what triggers autohealing. 2943 "onHealthCheck": "A String", # If you have configured an application-based health check for the group, this field controls whether to trigger VM autohealing based on a failed health check. Valid values are: - ON (default): The group recreates running VMs that fail the application-based health check. - OFF: When set to OFF, you can still observe instance health state, but the group does not recreate VMs that fail the application-based health check. This is useful for troubleshooting and setting up your health check configuration. 2944 }, 2945 "healthCheck": "A String", # The URL for the health check that signals autohealing. 2946 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. 2947 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded if necessary. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. 2948 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 2949 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 2950 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 2951 }, 2952 "updateInstances": "A String", 2953 }, 2954 ], 2955 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. 2956 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 2957 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. 2958 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. 2959 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 2960 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. 2961 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 2962 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 2963 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. 2964 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. 2965 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 2966 "resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. 2967 "starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. 2968 "stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. 2969 "suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. 2970 "verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. 2971 }, 2972 "description": "A String", # An optional description of this resource. 2973 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 2974 "targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). 2975 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 2976 { 2977 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 2978 }, 2979 ], 2980 }, 2981 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 2982 "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. 2983 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 2984 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 2985 "instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager. 2986 "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them. 2987 "timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out. 2988 }, 2989 }, 2990 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. 2991 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 2992 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 2993 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 2994 { # The named port. For example: <"http", 80>. 2995 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 2996 "port": 42, # The port number, which can be a value between 1 and 65535. 2997 }, 2998 ], 2999 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 3000 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 3001 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 3002 "serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. 3003 "standbyPolicy": { # Standby policy for stopped and suspended instances. 3004 "initialDelaySec": 42, 3005 }, 3006 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 3007 "preservedState": { # Configuration of preserved resources. 3008 "disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. 3009 "a_key": { 3010 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 3011 }, 3012 }, 3013 "externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 3014 "a_key": { 3015 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 3016 }, 3017 }, 3018 "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. 3019 "a_key": { 3020 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 3021 }, 3022 }, 3023 }, 3024 }, 3025 "status": { # [Output Only] The status of this managed instance group. 3026 "allInstancesConfig": { # [Output Only] A status of consistency of Instances' config applied to instances with Instances' config defined in managed instance group. 3027 "currentRevision": "A String", # [Output Only] Current instances' config revision. This value is in RFC3339 text format. 3028 "effective": True or False, # [Output Only] A bit indicating whether instances' config has been applied to all managed instances in managed instance group. 3029 }, 3030 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 3031 "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. 3032 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 3033 "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. 3034 "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config. 3035 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 3036 "allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs. 3037 }, 3038 }, 3039 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 3040 "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. 3041 }, 3042 }, 3043 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. 3044 "A String", 3045 ], 3046 "targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. 3047 "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. 3048 "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. 3049 "updatePolicy": { # The update policy for this managed instance group. 3050 "instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. 3051 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. 3052 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 3053 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 3054 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 3055 }, 3056 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. 3057 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 3058 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 3059 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 3060 }, 3061 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 3062 "minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. 3063 "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. 3064 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 3065 "type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). 3066 }, 3067 "versions": [ # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. 3068 { 3069 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached. 3070 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 3071 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. 3072 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. 3073 "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. 3074 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 3075 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 3076 }, 3077 }, 3078 ], 3079 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 3080} 3081 3082 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3083 x__xgafv: string, V1 error format. 3084 Allowed values 3085 1 - v1 error format 3086 2 - v2 error format 3087 3088Returns: 3089 An object of the form: 3090 3091 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3092 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3093 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3094 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3095 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3096 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3097 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3098 { 3099 "code": "A String", # [Output Only] The error type identifier for this error. 3100 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3101 "message": "A String", # [Output Only] An optional, human-readable error message. 3102 }, 3103 ], 3104 }, 3105 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3106 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 3107 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3108 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3109 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3110 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 3111 "a_key": "", # Properties of the object. Contains field @type with type URL. 3112 }, 3113 "name": "A String", # [Output Only] Name of the operation. 3114 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3115 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3116 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 3117 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3118 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3119 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 3120 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3121 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3122 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3123 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3124 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 3125 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3126 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3127 { 3128 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3129 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3130 { 3131 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 3132 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3133 }, 3134 ], 3135 "message": "A String", # [Output Only] A human-readable description of the warning code. 3136 }, 3137 ], 3138 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3139}</pre> 3140</div> 3141 3142<div class="method"> 3143 <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 3144 <pre>Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. 3145 3146Args: 3147 project: string, Project ID for this request. (required) 3148 zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required) 3149 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 3150 body: object, The request body. 3151 The object takes the form of: 3152 3153{ # InstanceGroupManagers.updatePerInstanceConfigs 3154 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 3155 { 3156 "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. 3157 "name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error. 3158 "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. 3159 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 3160 "a_key": { 3161 "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. 3162 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. 3163 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 3164 }, 3165 }, 3166 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 3167 "a_key": { 3168 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 3169 "ipAddress": { # Ip address representation 3170 "address": "A String", # The URL of the reservation for this IP address. 3171 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 3172 }, 3173 }, 3174 }, 3175 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 3176 "a_key": { 3177 "autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. 3178 "ipAddress": { # Ip address representation 3179 "address": "A String", # The URL of the reservation for this IP address. 3180 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 3181 }, 3182 }, 3183 }, 3184 "metadata": { # Preserved metadata defined for this instance. 3185 "a_key": "A String", 3186 }, 3187 }, 3188 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 3189 }, 3190 ], 3191} 3192 3193 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3194 x__xgafv: string, V1 error format. 3195 Allowed values 3196 1 - v1 error format 3197 2 - v2 error format 3198 3199Returns: 3200 An object of the form: 3201 3202 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3203 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3204 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3205 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3206 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3207 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3208 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3209 { 3210 "code": "A String", # [Output Only] The error type identifier for this error. 3211 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3212 "message": "A String", # [Output Only] An optional, human-readable error message. 3213 }, 3214 ], 3215 }, 3216 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3217 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 3218 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3219 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3220 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3221 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 3222 "a_key": "", # Properties of the object. Contains field @type with type URL. 3223 }, 3224 "name": "A String", # [Output Only] Name of the operation. 3225 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3226 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3227 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 3228 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3229 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3230 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 3231 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3232 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3233 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3234 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3235 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 3236 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3237 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3238 { 3239 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3240 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3241 { 3242 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 3243 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3244 }, 3245 ], 3246 "message": "A String", # [Output Only] A human-readable description of the warning code. 3247 }, 3248 ], 3249 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3250}</pre> 3251</div> 3252 3253</body></html>