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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Flags the specified instances to be immediately 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="#applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Apply updates to selected instances the managed instance group.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates instances with per-instance configs in this regional 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> 89<p class="toc_element"> 90 <code><a href="#delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p> 92<p class="toc_element"> 93 <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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> 95<p class="toc_element"> 96 <code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Deletes selected per-instance configs for the managed instance group.</p> 98<p class="toc_element"> 99 <code><a href="#get">get(project, region, instanceGroupManager, x__xgafv=None)</a></code></p> 100<p class="firstline">Returns all of the details about the specified managed instance group.</p> 101<p class="toc_element"> 102 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<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 regional managed instance group can contain up to 2000 instances.</p> 104<p class="toc_element"> 105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p> 107<p class="toc_element"> 108 <code><a href="#listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.</p> 110<p class="toc_element"> 111 <code><a href="#listErrors_next">listErrors_next(previous_request, previous_response)</a></code></p> 112<p class="firstline">Retrieves the next page of results.</p> 113<p class="toc_element"> 114 <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.</p> 116<p class="toc_element"> 117 <code><a href="#listManagedInstances_next">listManagedInstances_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="#listPerInstanceConfigs">listPerInstanceConfigs(project, region, 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 per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.</p> 122<p class="toc_element"> 123 <code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_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="#list_next">list_next(previous_request, previous_response)</a></code></p> 127<p class="firstline">Retrieves the next page of results.</p> 128<p class="toc_element"> 129 <code><a href="#patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 130<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> 131<p class="toc_element"> 132 <code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 133<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> 134<p class="toc_element"> 135 <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 136<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> 137<p class="toc_element"> 138 <code><a href="#resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</a></code></p> 139<p class="firstline">Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.</p> 140<p class="toc_element"> 141 <code><a href="#resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 142<p class="firstline">Resizes the regional 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, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating 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> 143<p class="toc_element"> 144 <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 145<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead.</p> 146<p class="toc_element"> 147 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 148<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p> 149<p class="toc_element"> 150 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 151<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p> 152<p class="toc_element"> 153 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> 154<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 155<p class="toc_element"> 156 <code><a href="#update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 157<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> 158<p class="toc_element"> 159 <code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 160<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> 161<h3>Method Details</h3> 162<div class="method"> 163 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 164 <pre>Flags the specified instances to be immediately 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. 165 166Args: 167 project: string, Project ID for this request. (required) 168 region: string, Name of the region scoping this request. (required) 169 instanceGroupManager: string, Name of the managed instance group. (required) 170 body: object, The request body. 171 The object takes the form of: 172 173{ 174 "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]. 175 "A String", 176 ], 177} 178 179 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). 180 x__xgafv: string, V1 error format. 181 Allowed values 182 1 - v1 error format 183 2 - v2 error format 184 185Returns: 186 An object of the form: 187 188 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 189 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 190 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 191 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 192 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 193 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 194 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 195 { 196 "code": "A String", # [Output Only] The error type identifier for this error. 197 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 198 "message": "A String", # [Output Only] An optional, human-readable error message. 199 }, 200 ], 201 }, 202 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 203 "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. 204 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 205 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 206 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 207 "name": "A String", # [Output Only] Name of the operation. 208 "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. 209 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 210 "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. 211 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 212 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 213 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 214 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 215 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 216 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 217 "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. 218 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 219 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 220 { 221 "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. 222 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 223 { 224 "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). 225 "value": "A String", # [Output Only] A warning data value corresponding to the key. 226 }, 227 ], 228 "message": "A String", # [Output Only] A human-readable description of the warning code. 229 }, 230 ], 231 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 232}</pre> 233</div> 234 235<div class="method"> 236 <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> 237 <pre>Apply updates to selected instances the managed instance group. 238 239Args: 240 project: string, Project ID for this request. (required) 241 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 242 instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required) 243 body: object, The request body. 244 The object takes the form of: 245 246{ # RegionInstanceGroupManagers.applyUpdatesToInstances 247 "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. 248 "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]. 249 "A String", 250 ], 251 "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. 252 "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. 253} 254 255 x__xgafv: string, V1 error format. 256 Allowed values 257 1 - v1 error format 258 2 - v2 error format 259 260Returns: 261 An object of the form: 262 263 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 264 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 265 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 266 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 267 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 268 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 269 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 270 { 271 "code": "A String", # [Output Only] The error type identifier for this error. 272 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 273 "message": "A String", # [Output Only] An optional, human-readable error message. 274 }, 275 ], 276 }, 277 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 278 "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. 279 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 280 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 281 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 282 "name": "A String", # [Output Only] Name of the operation. 283 "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. 284 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 285 "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. 286 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 287 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 288 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 289 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 290 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 291 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 292 "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. 293 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 294 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 295 { 296 "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. 297 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 298 { 299 "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). 300 "value": "A String", # [Output Only] A warning data value corresponding to the key. 301 }, 302 ], 303 "message": "A String", # [Output Only] A human-readable description of the warning code. 304 }, 305 ], 306 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 307}</pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="close">close()</code> 312 <pre>Close httplib2 connections.</pre> 313</div> 314 315<div class="method"> 316 <code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 317 <pre>Creates instances with per-instance configs in this regional 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. 318 319Args: 320 project: string, Project ID for this request. (required) 321 region: string, The name of the region where the managed instance group is located. It should conform to RFC1035. (required) 322 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 323 body: object, The request body. 324 The object takes the form of: 325 326{ # RegionInstanceGroupManagers.createInstances 327 "instances": [ # [Required] List of specifications of per-instance configs. 328 { 329 "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. 330 "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. 331 "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. 332 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 333 "a_key": { 334 "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. 335 "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. 336 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 337 }, 338 }, 339 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 340 "a_key": { 341 "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. 342 "ipAddress": { # Ip address representation 343 "address": "A String", # The URL of the reservation for this IP address. 344 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 345 }, 346 }, 347 }, 348 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 349 "a_key": { 350 "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. 351 "ipAddress": { # Ip address representation 352 "address": "A String", # The URL of the reservation for this IP address. 353 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 354 }, 355 }, 356 }, 357 "metadata": { # Preserved metadata defined for this instance. 358 "a_key": "A String", 359 }, 360 }, 361 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 362 }, 363 ], 364} 365 366 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). 367 x__xgafv: string, V1 error format. 368 Allowed values 369 1 - v1 error format 370 2 - v2 error format 371 372Returns: 373 An object of the form: 374 375 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 376 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 377 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 378 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 379 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 380 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 381 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 382 { 383 "code": "A String", # [Output Only] The error type identifier for this error. 384 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 385 "message": "A String", # [Output Only] An optional, human-readable error message. 386 }, 387 ], 388 }, 389 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 390 "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. 391 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 392 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 393 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 394 "name": "A String", # [Output Only] Name of the operation. 395 "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. 396 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 397 "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. 398 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 399 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 400 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 401 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 402 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 403 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 404 "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. 405 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 406 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 407 { 408 "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. 409 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 410 { 411 "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). 412 "value": "A String", # [Output Only] A warning data value corresponding to the key. 413 }, 414 ], 415 "message": "A String", # [Output Only] A human-readable description of the warning code. 416 }, 417 ], 418 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 419}</pre> 420</div> 421 422<div class="method"> 423 <code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</code> 424 <pre>Deletes the specified managed instance group and all of the instances in that group. 425 426Args: 427 project: string, Project ID for this request. (required) 428 region: string, Name of the region scoping this request. (required) 429 instanceGroupManager: string, Name of the managed instance group to delete. (required) 430 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). 431 x__xgafv: string, V1 error format. 432 Allowed values 433 1 - v1 error format 434 2 - v2 error format 435 436Returns: 437 An object of the form: 438 439 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 440 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 441 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 442 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 443 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 444 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 445 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 446 { 447 "code": "A String", # [Output Only] The error type identifier for this error. 448 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 449 "message": "A String", # [Output Only] An optional, human-readable error message. 450 }, 451 ], 452 }, 453 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 454 "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. 455 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 456 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 457 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 458 "name": "A String", # [Output Only] Name of the operation. 459 "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. 460 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 461 "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. 462 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 463 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 464 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 465 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 466 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 467 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 468 "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. 469 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 470 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 471 { 472 "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. 473 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 474 { 475 "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). 476 "value": "A String", # [Output Only] A warning data value corresponding to the key. 477 }, 478 ], 479 "message": "A String", # [Output Only] A human-readable description of the warning code. 480 }, 481 ], 482 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 483}</pre> 484</div> 485 486<div class="method"> 487 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 488 <pre>Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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. 489 490Args: 491 project: string, Project ID for this request. (required) 492 region: string, Name of the region scoping this request. (required) 493 instanceGroupManager: string, Name of the managed instance group. (required) 494 body: object, The request body. 495 The object takes the form of: 496 497{ 498 "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]. 499 "A String", 500 ], 501 "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. 502} 503 504 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). 505 x__xgafv: string, V1 error format. 506 Allowed values 507 1 - v1 error format 508 2 - v2 error format 509 510Returns: 511 An object of the form: 512 513 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 514 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 515 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 516 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 517 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 518 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 519 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 520 { 521 "code": "A String", # [Output Only] The error type identifier for this error. 522 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 523 "message": "A String", # [Output Only] An optional, human-readable error message. 524 }, 525 ], 526 }, 527 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 528 "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. 529 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 530 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 531 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 532 "name": "A String", # [Output Only] Name of the operation. 533 "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. 534 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 535 "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. 536 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 537 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 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="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> 562 <pre>Deletes selected per-instance configs for the managed instance group. 563 564Args: 565 project: string, Project ID for this request. (required) 566 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 567 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 568 body: object, The request body. 569 The object takes the form of: 570 571{ # RegionInstanceGroupManagers.deletePerInstanceConfigs 572 "names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group. 573 "A String", 574 ], 575} 576 577 x__xgafv: string, V1 error format. 578 Allowed values 579 1 - v1 error format 580 2 - v2 error format 581 582Returns: 583 An object of the form: 584 585 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 586 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 587 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 588 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 589 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 590 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 591 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 592 { 593 "code": "A String", # [Output Only] The error type identifier for this error. 594 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 595 "message": "A String", # [Output Only] An optional, human-readable error message. 596 }, 597 ], 598 }, 599 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 600 "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. 601 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 602 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 603 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 604 "name": "A String", # [Output Only] Name of the operation. 605 "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. 606 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 607 "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. 608 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 609 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 610 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 611 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 612 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 613 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 614 "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. 615 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 616 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 617 { 618 "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. 619 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 620 { 621 "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). 622 "value": "A String", # [Output Only] A warning data value corresponding to the key. 623 }, 624 ], 625 "message": "A String", # [Output Only] A human-readable description of the warning code. 626 }, 627 ], 628 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 629}</pre> 630</div> 631 632<div class="method"> 633 <code class="details" id="get">get(project, region, instanceGroupManager, x__xgafv=None)</code> 634 <pre>Returns all of the details about the specified managed instance group. 635 636Args: 637 project: string, Project ID for this request. (required) 638 region: string, Name of the region scoping this request. (required) 639 instanceGroupManager: string, Name of the managed instance group to return. (required) 640 x__xgafv: string, V1 error format. 641 Allowed values 642 1 - v1 error format 643 2 - v2 error format 644 645Returns: 646 An object of the form: 647 648 { # 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. 649 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 650 { 651 "healthCheck": "A String", # The URL for the health check that signals autohealing. 652 "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]. 653 }, 654 ], 655 "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. 656 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 657 "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. 658 "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. 659 "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. 660 "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. 661 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 662 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 663 "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. 664 "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. 665 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 666 "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. 667 }, 668 "description": "A String", # An optional description of this resource. 669 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 670 "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). 671 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 672 { 673 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 674 }, 675 ], 676 }, 677 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 678 "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. 679 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 680 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 681 "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. 682 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 683 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 684 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 685 { # The named port. For example: <"http", 80>. 686 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 687 "port": 42, # The port number, which can be a value between 1 and 65535. 688 }, 689 ], 690 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 691 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 692 "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. 693 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 694 "preservedState": { # Configuration of preserved resources. 695 "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. 696 "a_key": { 697 "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. 698 }, 699 }, 700 "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. 701 "a_key": { 702 "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. 703 }, 704 }, 705 "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. 706 "a_key": { 707 "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. 708 }, 709 }, 710 }, 711 }, 712 "status": { # [Output Only] The status of this managed instance group. 713 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 714 "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. 715 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 716 "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. 717 "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. 718 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 719 "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. 720 }, 721 }, 722 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 723 "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. 724 }, 725 }, 726 "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. 727 "A String", 728 ], 729 "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. 730 "updatePolicy": { # The update policy for this managed instance group. 731 "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. 732 "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. 733 "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. 734 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 735 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 736 }, 737 "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. 738 "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. 739 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 740 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 741 }, 742 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 743 "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. 744 "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. 745 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 746 "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). 747 }, 748 "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. 749 { 750 "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. 751 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 752 "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. 753 "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. 754 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 755 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 756 }, 757 }, 758 ], 759 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 760}</pre> 761</div> 762 763<div class="method"> 764 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 765 <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 regional managed instance group can contain up to 2000 instances. 766 767Args: 768 project: string, Project ID for this request. (required) 769 region: string, Name of the region scoping this request. (required) 770 body: object, The request body. 771 The object takes the form of: 772 773{ # 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. 774 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 775 { 776 "healthCheck": "A String", # The URL for the health check that signals autohealing. 777 "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]. 778 }, 779 ], 780 "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. 781 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 782 "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. 783 "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. 784 "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. 785 "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. 786 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 787 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 788 "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. 789 "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. 790 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 791 "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. 792 }, 793 "description": "A String", # An optional description of this resource. 794 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 795 "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). 796 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 797 { 798 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 799 }, 800 ], 801 }, 802 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 803 "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. 804 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 805 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 806 "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. 807 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 808 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 809 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 810 { # The named port. For example: <"http", 80>. 811 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 812 "port": 42, # The port number, which can be a value between 1 and 65535. 813 }, 814 ], 815 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 816 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 817 "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. 818 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 819 "preservedState": { # Configuration of preserved resources. 820 "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. 821 "a_key": { 822 "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. 823 }, 824 }, 825 "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. 826 "a_key": { 827 "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. 828 }, 829 }, 830 "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. 831 "a_key": { 832 "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. 833 }, 834 }, 835 }, 836 }, 837 "status": { # [Output Only] The status of this managed instance group. 838 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 839 "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. 840 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 841 "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. 842 "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. 843 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 844 "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. 845 }, 846 }, 847 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 848 "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. 849 }, 850 }, 851 "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. 852 "A String", 853 ], 854 "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. 855 "updatePolicy": { # The update policy for this managed instance group. 856 "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. 857 "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. 858 "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. 859 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 860 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 861 }, 862 "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. 863 "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. 864 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 865 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 866 }, 867 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 868 "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. 869 "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. 870 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 871 "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). 872 }, 873 "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. 874 { 875 "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. 876 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 877 "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. 878 "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. 879 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 880 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 881 }, 882 }, 883 ], 884 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 885} 886 887 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). 888 x__xgafv: string, V1 error format. 889 Allowed values 890 1 - v1 error format 891 2 - v2 error format 892 893Returns: 894 An object of the form: 895 896 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 897 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 898 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 899 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 900 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 901 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 902 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 903 { 904 "code": "A String", # [Output Only] The error type identifier for this error. 905 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 906 "message": "A String", # [Output Only] An optional, human-readable error message. 907 }, 908 ], 909 }, 910 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 911 "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. 912 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 913 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 914 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 915 "name": "A String", # [Output Only] Name of the operation. 916 "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. 917 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 918 "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. 919 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 920 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 921 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 922 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 923 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 924 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 925 "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. 926 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 927 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 928 { 929 "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. 930 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 931 { 932 "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). 933 "value": "A String", # [Output Only] A warning data value corresponding to the key. 934 }, 935 ], 936 "message": "A String", # [Output Only] A human-readable description of the warning code. 937 }, 938 ], 939 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 940}</pre> 941</div> 942 943<div class="method"> 944 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 945 <pre>Retrieves the list of managed instance groups that are contained within the specified region. 946 947Args: 948 project: string, Project ID for this request. (required) 949 region: string, Name of the region scoping this request. (required) 950 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) ``` 951 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`) 952 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. 953 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. 954 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 955 x__xgafv: string, V1 error format. 956 Allowed values 957 1 - v1 error format 958 2 - v2 error format 959 960Returns: 961 An object of the form: 962 963 { # Contains a list of managed instance groups. 964 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 965 "items": [ # A list of InstanceGroupManager resources. 966 { # 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. 967 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 968 { 969 "healthCheck": "A String", # The URL for the health check that signals autohealing. 970 "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]. 971 }, 972 ], 973 "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. 974 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 975 "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. 976 "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. 977 "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. 978 "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. 979 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 980 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 981 "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. 982 "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. 983 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 984 "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. 985 }, 986 "description": "A String", # An optional description of this resource. 987 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 988 "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). 989 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 990 { 991 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 992 }, 993 ], 994 }, 995 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 996 "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. 997 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 998 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 999 "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. 1000 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1001 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1002 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1003 { # The named port. For example: <"http", 80>. 1004 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1005 "port": 42, # The port number, which can be a value between 1 and 65535. 1006 }, 1007 ], 1008 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1009 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1010 "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. 1011 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1012 "preservedState": { # Configuration of preserved resources. 1013 "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. 1014 "a_key": { 1015 "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. 1016 }, 1017 }, 1018 "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. 1019 "a_key": { 1020 "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. 1021 }, 1022 }, 1023 "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. 1024 "a_key": { 1025 "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. 1026 }, 1027 }, 1028 }, 1029 }, 1030 "status": { # [Output Only] The status of this managed instance group. 1031 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1032 "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. 1033 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1034 "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. 1035 "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. 1036 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1037 "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. 1038 }, 1039 }, 1040 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1041 "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. 1042 }, 1043 }, 1044 "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. 1045 "A String", 1046 ], 1047 "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. 1048 "updatePolicy": { # The update policy for this managed instance group. 1049 "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. 1050 "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. 1051 "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. 1052 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1053 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1054 }, 1055 "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. 1056 "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. 1057 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1058 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1059 }, 1060 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1061 "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. 1062 "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. 1063 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1064 "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). 1065 }, 1066 "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. 1067 { 1068 "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. 1069 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1070 "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. 1071 "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. 1072 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1073 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1074 }, 1075 }, 1076 ], 1077 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1078 }, 1079 ], 1080 "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. 1081 "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. 1082 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1083 "warning": { # [Output Only] Informational warning message. 1084 "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. 1085 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1086 { 1087 "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). 1088 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1089 }, 1090 ], 1091 "message": "A String", # [Output Only] A human-readable description of the warning code. 1092 }, 1093}</pre> 1094</div> 1095 1096<div class="method"> 1097 <code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1098 <pre>Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. 1099 1100Args: 1101 project: string, Project ID for this request. (required) 1102 region: string, Name of the region scoping this request. This should conform to RFC1035. (required) 1103 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) 1104 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) ``` 1105 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`) 1106 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. 1107 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. 1108 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1109 x__xgafv: string, V1 error format. 1110 Allowed values 1111 1 - v1 error format 1112 2 - v2 error format 1113 1114Returns: 1115 An object of the form: 1116 1117 { 1118 "items": [ # [Output Only] The list of errors of the managed instance group. 1119 { 1120 "error": { # [Output Only] Contents of the error. 1121 "code": "A String", # [Output Only] Error code. 1122 "message": "A String", # [Output Only] Error message. 1123 }, 1124 "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. 1125 "action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: 1126 "instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created. 1127 "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. 1128 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1129 "name": "A String", # [Output Only] Name of the version. 1130 }, 1131 }, 1132 "timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format. 1133 }, 1134 ], 1135 "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. 1136}</pre> 1137</div> 1138 1139<div class="method"> 1140 <code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code> 1141 <pre>Retrieves the next page of results. 1142 1143Args: 1144 previous_request: The request for the previous page. (required) 1145 previous_response: The response from the request for the previous page. (required) 1146 1147Returns: 1148 A request object that you can call 'execute()' on to request the next 1149 page. Returns None if there are no more items in the collection. 1150 </pre> 1151</div> 1152 1153<div class="method"> 1154 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1155 <pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. 1156 1157Args: 1158 project: string, Project ID for this request. (required) 1159 region: string, Name of the region scoping this request. (required) 1160 instanceGroupManager: string, The name of the managed instance group. (required) 1161 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) ``` 1162 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`) 1163 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. 1164 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. 1165 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1166 x__xgafv: string, V1 error format. 1167 Allowed values 1168 1 - v1 error format 1169 2 - v2 error format 1170 1171Returns: 1172 An object of the form: 1173 1174 { 1175 "managedInstances": [ # A list of managed instances. 1176 { # A Managed Instance resource. 1177 "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. 1178 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist. 1179 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. 1180 "instanceHealth": [ # [Output Only] Health state of the instance per health-check. 1181 { 1182 "detailedHealthState": "A String", # [Output Only] The current detailed instance health state. 1183 "healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy. 1184 }, 1185 ], 1186 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist. 1187 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance. 1188 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance. 1189 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1190 { 1191 "code": "A String", # [Output Only] The error type identifier for this error. 1192 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1193 "message": "A String", # [Output Only] An optional, human-readable error message. 1194 }, 1195 ], 1196 }, 1197 }, 1198 "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance. 1199 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1200 "a_key": { 1201 "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. 1202 "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. 1203 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1204 }, 1205 }, 1206 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1207 "a_key": { 1208 "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. 1209 "ipAddress": { # Ip address representation 1210 "address": "A String", # The URL of the reservation for this IP address. 1211 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1212 }, 1213 }, 1214 }, 1215 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1216 "a_key": { 1217 "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. 1218 "ipAddress": { # Ip address representation 1219 "address": "A String", # The URL of the reservation for this IP address. 1220 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1221 }, 1222 }, 1223 }, 1224 "metadata": { # Preserved metadata defined for this instance. 1225 "a_key": "A String", 1226 }, 1227 }, 1228 "preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy for this instance. 1229 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1230 "a_key": { 1231 "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. 1232 "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. 1233 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1234 }, 1235 }, 1236 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1237 "a_key": { 1238 "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. 1239 "ipAddress": { # Ip address representation 1240 "address": "A String", # The URL of the reservation for this IP address. 1241 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1242 }, 1243 }, 1244 }, 1245 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1246 "a_key": { 1247 "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. 1248 "ipAddress": { # Ip address representation 1249 "address": "A String", # The URL of the reservation for this IP address. 1250 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1251 }, 1252 }, 1253 }, 1254 "metadata": { # Preserved metadata defined for this instance. 1255 "a_key": "A String", 1256 }, 1257 }, 1258 "version": { # [Output Only] Intended version of this instance. 1259 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1260 "name": "A String", # [Output Only] Name of the version. 1261 }, 1262 }, 1263 ], 1264 "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. 1265}</pre> 1266</div> 1267 1268<div class="method"> 1269 <code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code> 1270 <pre>Retrieves the next page of results. 1271 1272Args: 1273 previous_request: The request for the previous page. (required) 1274 previous_response: The response from the request for the previous page. (required) 1275 1276Returns: 1277 A request object that you can call 'execute()' on to request the next 1278 page. Returns None if there are no more items in the collection. 1279 </pre> 1280</div> 1281 1282<div class="method"> 1283 <code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1284 <pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported. 1285 1286Args: 1287 project: string, Project ID for this request. (required) 1288 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 1289 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1290 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) ``` 1291 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`) 1292 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. 1293 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. 1294 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1295 x__xgafv: string, V1 error format. 1296 Allowed values 1297 1 - v1 error format 1298 2 - v2 error format 1299 1300Returns: 1301 An object of the form: 1302 1303 { 1304 "items": [ # [Output Only] The list of PerInstanceConfig. 1305 { 1306 "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. 1307 "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. 1308 "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. 1309 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1310 "a_key": { 1311 "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. 1312 "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. 1313 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1314 }, 1315 }, 1316 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1317 "a_key": { 1318 "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. 1319 "ipAddress": { # Ip address representation 1320 "address": "A String", # The URL of the reservation for this IP address. 1321 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1322 }, 1323 }, 1324 }, 1325 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1326 "a_key": { 1327 "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. 1328 "ipAddress": { # Ip address representation 1329 "address": "A String", # The URL of the reservation for this IP address. 1330 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1331 }, 1332 }, 1333 }, 1334 "metadata": { # Preserved metadata defined for this instance. 1335 "a_key": "A String", 1336 }, 1337 }, 1338 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1339 }, 1340 ], 1341 "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. 1342 "warning": { # [Output Only] Informational warning message. 1343 "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. 1344 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1345 { 1346 "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). 1347 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1348 }, 1349 ], 1350 "message": "A String", # [Output Only] A human-readable description of the warning code. 1351 }, 1352}</pre> 1353</div> 1354 1355<div class="method"> 1356 <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code> 1357 <pre>Retrieves the next page of results. 1358 1359Args: 1360 previous_request: The request for the previous page. (required) 1361 previous_response: The response from the request for the previous page. (required) 1362 1363Returns: 1364 A request object that you can call 'execute()' on to request the next 1365 page. Returns None if there are no more items in the collection. 1366 </pre> 1367</div> 1368 1369<div class="method"> 1370 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1371 <pre>Retrieves the next page of results. 1372 1373Args: 1374 previous_request: The request for the previous page. (required) 1375 previous_response: The response from the request for the previous page. (required) 1376 1377Returns: 1378 A request object that you can call 'execute()' on to request the next 1379 page. Returns None if there are no more items in the collection. 1380 </pre> 1381</div> 1382 1383<div class="method"> 1384 <code class="details" id="patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1385 <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. 1386 1387Args: 1388 project: string, Project ID for this request. (required) 1389 region: string, Name of the region scoping this request. (required) 1390 instanceGroupManager: string, The name of the instance group manager. (required) 1391 body: object, The request body. 1392 The object takes the form of: 1393 1394{ # 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. 1395 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1396 { 1397 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1398 "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]. 1399 }, 1400 ], 1401 "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. 1402 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1403 "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. 1404 "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. 1405 "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. 1406 "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. 1407 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1408 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1409 "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. 1410 "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. 1411 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1412 "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. 1413 }, 1414 "description": "A String", # An optional description of this resource. 1415 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 1416 "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). 1417 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 1418 { 1419 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 1420 }, 1421 ], 1422 }, 1423 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 1424 "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. 1425 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1426 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1427 "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. 1428 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1429 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1430 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1431 { # The named port. For example: <"http", 80>. 1432 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1433 "port": 42, # The port number, which can be a value between 1 and 65535. 1434 }, 1435 ], 1436 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1437 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1438 "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. 1439 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1440 "preservedState": { # Configuration of preserved resources. 1441 "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. 1442 "a_key": { 1443 "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. 1444 }, 1445 }, 1446 "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. 1447 "a_key": { 1448 "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. 1449 }, 1450 }, 1451 "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. 1452 "a_key": { 1453 "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. 1454 }, 1455 }, 1456 }, 1457 }, 1458 "status": { # [Output Only] The status of this managed instance group. 1459 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1460 "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. 1461 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1462 "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. 1463 "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. 1464 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1465 "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. 1466 }, 1467 }, 1468 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1469 "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. 1470 }, 1471 }, 1472 "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. 1473 "A String", 1474 ], 1475 "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. 1476 "updatePolicy": { # The update policy for this managed instance group. 1477 "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. 1478 "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. 1479 "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. 1480 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1481 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1482 }, 1483 "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. 1484 "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. 1485 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1486 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1487 }, 1488 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 1489 "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. 1490 "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. 1491 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1492 "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). 1493 }, 1494 "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. 1495 { 1496 "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. 1497 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1498 "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. 1499 "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. 1500 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1501 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1502 }, 1503 }, 1504 ], 1505 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1506} 1507 1508 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). 1509 x__xgafv: string, V1 error format. 1510 Allowed values 1511 1 - v1 error format 1512 2 - v2 error format 1513 1514Returns: 1515 An object of the form: 1516 1517 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1518 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1519 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1520 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1521 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1522 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1523 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1524 { 1525 "code": "A String", # [Output Only] The error type identifier for this error. 1526 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1527 "message": "A String", # [Output Only] An optional, human-readable error message. 1528 }, 1529 ], 1530 }, 1531 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1532 "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. 1533 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1534 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1535 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1536 "name": "A String", # [Output Only] Name of the operation. 1537 "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. 1538 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1539 "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. 1540 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1541 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1542 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1543 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1544 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1545 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1546 "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. 1547 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1548 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1549 { 1550 "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. 1551 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1552 { 1553 "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). 1554 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1555 }, 1556 ], 1557 "message": "A String", # [Output Only] A human-readable description of the warning code. 1558 }, 1559 ], 1560 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1561}</pre> 1562</div> 1563 1564<div class="method"> 1565 <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1566 <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. 1567 1568Args: 1569 project: string, Project ID for this request. (required) 1570 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 1571 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1572 body: object, The request body. 1573 The object takes the form of: 1574 1575{ # RegionInstanceGroupManagers.patchPerInstanceConfigs 1576 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 1577 { 1578 "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. 1579 "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. 1580 "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. 1581 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1582 "a_key": { 1583 "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. 1584 "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. 1585 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1586 }, 1587 }, 1588 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 1589 "a_key": { 1590 "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. 1591 "ipAddress": { # Ip address representation 1592 "address": "A String", # The URL of the reservation for this IP address. 1593 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1594 }, 1595 }, 1596 }, 1597 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 1598 "a_key": { 1599 "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. 1600 "ipAddress": { # Ip address representation 1601 "address": "A String", # The URL of the reservation for this IP address. 1602 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 1603 }, 1604 }, 1605 }, 1606 "metadata": { # Preserved metadata defined for this instance. 1607 "a_key": "A String", 1608 }, 1609 }, 1610 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1611 }, 1612 ], 1613} 1614 1615 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). 1616 x__xgafv: string, V1 error format. 1617 Allowed values 1618 1 - v1 error format 1619 2 - v2 error format 1620 1621Returns: 1622 An object of the form: 1623 1624 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1625 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1626 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1627 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1628 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1629 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1630 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1631 { 1632 "code": "A String", # [Output Only] The error type identifier for this error. 1633 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1634 "message": "A String", # [Output Only] An optional, human-readable error message. 1635 }, 1636 ], 1637 }, 1638 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1639 "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. 1640 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1641 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1642 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1643 "name": "A String", # [Output Only] Name of the operation. 1644 "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. 1645 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1646 "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. 1647 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1648 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1649 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1650 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1651 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1652 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1653 "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. 1654 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1655 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1656 { 1657 "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. 1658 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1659 { 1660 "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). 1661 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1662 }, 1663 ], 1664 "message": "A String", # [Output Only] A human-readable description of the warning code. 1665 }, 1666 ], 1667 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1668}</pre> 1669</div> 1670 1671<div class="method"> 1672 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1673 <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. 1674 1675Args: 1676 project: string, Project ID for this request. (required) 1677 region: string, Name of the region scoping this request. (required) 1678 instanceGroupManager: string, Name of the managed instance group. (required) 1679 body: object, The request body. 1680 The object takes the form of: 1681 1682{ 1683 "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]. 1684 "A String", 1685 ], 1686} 1687 1688 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). 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 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1698 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1699 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1700 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1701 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1702 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1703 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1704 { 1705 "code": "A String", # [Output Only] The error type identifier for this error. 1706 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1707 "message": "A String", # [Output Only] An optional, human-readable error message. 1708 }, 1709 ], 1710 }, 1711 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1712 "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. 1713 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1714 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1715 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1716 "name": "A String", # [Output Only] Name of the operation. 1717 "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. 1718 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1719 "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. 1720 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1721 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1722 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1723 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1724 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1725 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1726 "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. 1727 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1728 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1729 { 1730 "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. 1731 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1732 { 1733 "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). 1734 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1735 }, 1736 ], 1737 "message": "A String", # [Output Only] A human-readable description of the warning code. 1738 }, 1739 ], 1740 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1741}</pre> 1742</div> 1743 1744<div class="method"> 1745 <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code> 1746 <pre>Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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. 1747 1748Args: 1749 project: string, Project ID for this request. (required) 1750 region: string, Name of the region scoping this request. (required) 1751 instanceGroupManager: string, Name of the managed instance group. (required) 1752 size: integer, Number of instances that should exist in this instance group manager. (required) 1753 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). 1754 x__xgafv: string, V1 error format. 1755 Allowed values 1756 1 - v1 error format 1757 2 - v2 error format 1758 1759Returns: 1760 An object of the form: 1761 1762 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1763 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1764 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1765 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1766 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1767 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1768 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1769 { 1770 "code": "A String", # [Output Only] The error type identifier for this error. 1771 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1772 "message": "A String", # [Output Only] An optional, human-readable error message. 1773 }, 1774 ], 1775 }, 1776 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1777 "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. 1778 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1779 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1780 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1781 "name": "A String", # [Output Only] Name of the operation. 1782 "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. 1783 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1784 "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. 1785 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1786 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1787 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1788 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1789 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1790 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1791 "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. 1792 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1793 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1794 { 1795 "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. 1796 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1797 { 1798 "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). 1799 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1800 }, 1801 ], 1802 "message": "A String", # [Output Only] A human-readable description of the warning code. 1803 }, 1804 ], 1805 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1806}</pre> 1807</div> 1808 1809<div class="method"> 1810 <code class="details" id="resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1811 <pre>Resizes the regional 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, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating 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. 1812 1813Args: 1814 project: string, Project ID for this request. (required) 1815 region: string, Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. (required) 1816 instanceGroupManager: string, The name of the managed instance group. It must be a string that meets the requirements in RFC1035. (required) 1817 body: object, The request body. 1818 The object takes the form of: 1819 1820{ 1821 "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 ar being created in which mode by calling the get or listManagedInstances API. 1822 "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. 1823} 1824 1825 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). 1826 x__xgafv: string, V1 error format. 1827 Allowed values 1828 1 - v1 error format 1829 2 - v2 error format 1830 1831Returns: 1832 An object of the form: 1833 1834 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1835 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1836 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1837 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1838 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1839 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1840 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1841 { 1842 "code": "A String", # [Output Only] The error type identifier for this error. 1843 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1844 "message": "A String", # [Output Only] An optional, human-readable error message. 1845 }, 1846 ], 1847 }, 1848 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1849 "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. 1850 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1851 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1852 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1853 "name": "A String", # [Output Only] Name of the operation. 1854 "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. 1855 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1856 "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. 1857 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1858 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1859 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1860 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1861 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1862 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1863 "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. 1864 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1865 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1866 { 1867 "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. 1868 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1869 { 1870 "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). 1871 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1872 }, 1873 ], 1874 "message": "A String", # [Output Only] A human-readable description of the warning code. 1875 }, 1876 ], 1877 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1878}</pre> 1879</div> 1880 1881<div class="method"> 1882 <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1883 <pre>Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. 1884 1885Args: 1886 project: string, Project ID for this request. (required) 1887 region: string, Name of the region scoping this request. (required) 1888 instanceGroupManager: string, Name of the managed instance group. (required) 1889 body: object, The request body. 1890 The object takes the form of: 1891 1892{ 1893 "autoHealingPolicies": [ 1894 { 1895 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1896 "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]. 1897 }, 1898 ], 1899} 1900 1901 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). 1902 x__xgafv: string, V1 error format. 1903 Allowed values 1904 1 - v1 error format 1905 2 - v2 error format 1906 1907Returns: 1908 An object of the form: 1909 1910 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1911 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1912 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1913 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1914 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1915 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1916 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1917 { 1918 "code": "A String", # [Output Only] The error type identifier for this error. 1919 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1920 "message": "A String", # [Output Only] An optional, human-readable error message. 1921 }, 1922 ], 1923 }, 1924 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1925 "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. 1926 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1927 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1928 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1929 "name": "A String", # [Output Only] Name of the operation. 1930 "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. 1931 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1932 "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. 1933 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1934 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1935 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1936 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1937 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1938 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1939 "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. 1940 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1941 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1942 { 1943 "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. 1944 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1945 { 1946 "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). 1947 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1948 }, 1949 ], 1950 "message": "A String", # [Output Only] A human-readable description of the warning code. 1951 }, 1952 ], 1953 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1954}</pre> 1955</div> 1956 1957<div class="method"> 1958 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1959 <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. 1960 1961Args: 1962 project: string, Project ID for this request. (required) 1963 region: string, Name of the region scoping this request. (required) 1964 instanceGroupManager: string, The name of the managed instance group. (required) 1965 body: object, The request body. 1966 The object takes the form of: 1967 1968{ 1969 "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created. 1970} 1971 1972 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). 1973 x__xgafv: string, V1 error format. 1974 Allowed values 1975 1 - v1 error format 1976 2 - v2 error format 1977 1978Returns: 1979 An object of the form: 1980 1981 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 1982 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1983 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1984 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1985 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1986 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1987 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1988 { 1989 "code": "A String", # [Output Only] The error type identifier for this error. 1990 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1991 "message": "A String", # [Output Only] An optional, human-readable error message. 1992 }, 1993 ], 1994 }, 1995 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1996 "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. 1997 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1998 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1999 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2000 "name": "A String", # [Output Only] Name of the operation. 2001 "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. 2002 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2003 "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. 2004 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2005 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2006 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2007 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2008 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2009 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2010 "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. 2011 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2012 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2013 { 2014 "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. 2015 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2016 { 2017 "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). 2018 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2019 }, 2020 ], 2021 "message": "A String", # [Output Only] A human-readable description of the warning code. 2022 }, 2023 ], 2024 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2025}</pre> 2026</div> 2027 2028<div class="method"> 2029 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2030 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. 2031 2032Args: 2033 project: string, Project ID for this request. (required) 2034 region: string, Name of the region scoping this request. (required) 2035 instanceGroupManager: string, Name of the managed instance group. (required) 2036 body: object, The request body. 2037 The object takes the form of: 2038 2039{ 2040 "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. 2041 "targetPools": [ # The URL of 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. 2042 "A String", 2043 ], 2044} 2045 2046 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). 2047 x__xgafv: string, V1 error format. 2048 Allowed values 2049 1 - v1 error format 2050 2 - v2 error format 2051 2052Returns: 2053 An object of the form: 2054 2055 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 2056 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2057 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2058 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2059 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2060 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2061 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2062 { 2063 "code": "A String", # [Output Only] The error type identifier for this error. 2064 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2065 "message": "A String", # [Output Only] An optional, human-readable error message. 2066 }, 2067 ], 2068 }, 2069 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2070 "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. 2071 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2072 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2073 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2074 "name": "A String", # [Output Only] Name of the operation. 2075 "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. 2076 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2077 "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. 2078 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2079 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2080 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2081 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2082 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2083 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2084 "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. 2085 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2086 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2087 { 2088 "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. 2089 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2090 { 2091 "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). 2092 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2093 }, 2094 ], 2095 "message": "A String", # [Output Only] A human-readable description of the warning code. 2096 }, 2097 ], 2098 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2099}</pre> 2100</div> 2101 2102<div class="method"> 2103 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> 2104 <pre>Returns permissions that a caller has on the specified resource. 2105 2106Args: 2107 project: string, Project ID for this request. (required) 2108 region: string, The name of the region for this request. (required) 2109 resource: string, Name or id of the resource for this request. (required) 2110 body: object, The request body. 2111 The object takes the form of: 2112 2113{ 2114 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 2115 "A String", 2116 ], 2117} 2118 2119 x__xgafv: string, V1 error format. 2120 Allowed values 2121 1 - v1 error format 2122 2 - v2 error format 2123 2124Returns: 2125 An object of the form: 2126 2127 { 2128 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 2129 "A String", 2130 ], 2131}</pre> 2132</div> 2133 2134<div class="method"> 2135 <code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2136 <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. 2137 2138Args: 2139 project: string, Project ID for this request. (required) 2140 region: string, Name of the region scoping this request. (required) 2141 instanceGroupManager: string, The name of the instance group manager. (required) 2142 body: object, The request body. 2143 The object takes the form of: 2144 2145{ # 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. 2146 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 2147 { 2148 "healthCheck": "A String", # The URL for the health check that signals autohealing. 2149 "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]. 2150 }, 2151 ], 2152 "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. 2153 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 2154 "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. 2155 "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. 2156 "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. 2157 "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. 2158 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 2159 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 2160 "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. 2161 "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. 2162 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 2163 "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. 2164 }, 2165 "description": "A String", # An optional description of this resource. 2166 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 2167 "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). 2168 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 2169 { 2170 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 2171 }, 2172 ], 2173 }, 2174 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 2175 "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. 2176 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 2177 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 2178 "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. 2179 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 2180 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 2181 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 2182 { # The named port. For example: <"http", 80>. 2183 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 2184 "port": 42, # The port number, which can be a value between 1 and 65535. 2185 }, 2186 ], 2187 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 2188 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 2189 "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. 2190 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 2191 "preservedState": { # Configuration of preserved resources. 2192 "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. 2193 "a_key": { 2194 "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. 2195 }, 2196 }, 2197 "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. 2198 "a_key": { 2199 "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. 2200 }, 2201 }, 2202 "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. 2203 "a_key": { 2204 "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. 2205 }, 2206 }, 2207 }, 2208 }, 2209 "status": { # [Output Only] The status of this managed instance group. 2210 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 2211 "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. 2212 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 2213 "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. 2214 "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. 2215 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 2216 "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. 2217 }, 2218 }, 2219 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 2220 "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. 2221 }, 2222 }, 2223 "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. 2224 "A String", 2225 ], 2226 "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. 2227 "updatePolicy": { # The update policy for this managed instance group. 2228 "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. 2229 "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. 2230 "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. 2231 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 2232 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 2233 }, 2234 "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. 2235 "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. 2236 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 2237 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 2238 }, 2239 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. 2240 "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. 2241 "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. 2242 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 2243 "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). 2244 }, 2245 "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. 2246 { 2247 "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. 2248 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 2249 "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. 2250 "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. 2251 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 2252 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 2253 }, 2254 }, 2255 ], 2256 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 2257} 2258 2259 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). 2260 x__xgafv: string, V1 error format. 2261 Allowed values 2262 1 - v1 error format 2263 2 - v2 error format 2264 2265Returns: 2266 An object of the form: 2267 2268 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 2269 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2270 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2271 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2272 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2273 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2274 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2275 { 2276 "code": "A String", # [Output Only] The error type identifier for this error. 2277 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2278 "message": "A String", # [Output Only] An optional, human-readable error message. 2279 }, 2280 ], 2281 }, 2282 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2283 "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. 2284 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2285 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2286 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2287 "name": "A String", # [Output Only] Name of the operation. 2288 "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. 2289 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2290 "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. 2291 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2292 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2293 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2294 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2295 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2296 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2297 "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. 2298 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2299 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2300 { 2301 "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. 2302 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2303 { 2304 "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). 2305 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2306 }, 2307 ], 2308 "message": "A String", # [Output Only] A human-readable description of the warning code. 2309 }, 2310 ], 2311 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2312}</pre> 2313</div> 2314 2315<div class="method"> 2316 <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 2317 <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. 2318 2319Args: 2320 project: string, Project ID for this request. (required) 2321 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 2322 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 2323 body: object, The request body. 2324 The object takes the form of: 2325 2326{ # RegionInstanceGroupManagers.updatePerInstanceConfigs 2327 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 2328 { 2329 "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. 2330 "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. 2331 "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. 2332 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 2333 "a_key": { 2334 "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. 2335 "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. 2336 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 2337 }, 2338 }, 2339 "externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. 2340 "a_key": { 2341 "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. 2342 "ipAddress": { # Ip address representation 2343 "address": "A String", # The URL of the reservation for this IP address. 2344 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 2345 }, 2346 }, 2347 }, 2348 "internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. 2349 "a_key": { 2350 "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. 2351 "ipAddress": { # Ip address representation 2352 "address": "A String", # The URL of the reservation for this IP address. 2353 "literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface. 2354 }, 2355 }, 2356 }, 2357 "metadata": { # Preserved metadata defined for this instance. 2358 "a_key": "A String", 2359 }, 2360 }, 2361 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 2362 }, 2363 ], 2364} 2365 2366 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). 2367 x__xgafv: string, V1 error format. 2368 Allowed values 2369 1 - v1 error format 2370 2 - v2 error format 2371 2372Returns: 2373 An object of the form: 2374 2375 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 2376 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2377 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2378 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2379 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2380 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2381 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2382 { 2383 "code": "A String", # [Output Only] The error type identifier for this error. 2384 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2385 "message": "A String", # [Output Only] An optional, human-readable error message. 2386 }, 2387 ], 2388 }, 2389 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2390 "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. 2391 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2392 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2393 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2394 "name": "A String", # [Output Only] Name of the operation. 2395 "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. 2396 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2397 "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. 2398 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2399 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2400 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2401 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2402 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2403 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2404 "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. 2405 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2406 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2407 { 2408 "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. 2409 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2410 { 2411 "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). 2412 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2413 }, 2414 ], 2415 "message": "A String", # [Output Only] A human-readable description of the warning code. 2416 }, 2417 ], 2418 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2419}</pre> 2420</div> 2421 2422</body></html>