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_v1.html">Compute Engine API</a> . <a href="compute_v1.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="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 142<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> 143<p class="toc_element"> 144 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 145<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> 146<p class="toc_element"> 147 <code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> 148<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> 149<h3>Method Details</h3> 150<div class="method"> 151 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 152 <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. 153 154Args: 155 project: string, Project ID for this request. (required) 156 region: string, Name of the region scoping this request. (required) 157 instanceGroupManager: string, Name of the managed instance group. (required) 158 body: object, The request body. 159 The object takes the form of: 160 161{ 162 "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]. 163 "A String", 164 ], 165} 166 167 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). 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 177 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 178 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 179 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 180 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 181 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 182 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 183 { 184 "code": "A String", # [Output Only] The error type identifier for this error. 185 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 186 "message": "A String", # [Output Only] An optional, human-readable error message. 187 }, 188 ], 189 }, 190 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 191 "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. 192 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 194 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 195 "name": "A String", # [Output Only] Name of the operation. 196 "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. 197 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 198 "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. 199 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 201 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 202 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 203 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 204 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 205 "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. 206 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 207 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 208 { 209 "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. 210 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 211 { 212 "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). 213 "value": "A String", # [Output Only] A warning data value corresponding to the key. 214 }, 215 ], 216 "message": "A String", # [Output Only] A human-readable description of the warning code. 217 }, 218 ], 219 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> 225 <pre>Apply updates to selected instances the managed instance group. 226 227Args: 228 project: string, Project ID for this request. (required) 229 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 230 instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required) 231 body: object, The request body. 232 The object takes the form of: 233 234{ # RegionInstanceGroupManagers.applyUpdatesToInstances 235 "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. 236 "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]. 237 "A String", 238 ], 239 "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. 240 "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. 241} 242 243 x__xgafv: string, V1 error format. 244 Allowed values 245 1 - v1 error format 246 2 - v2 error format 247 248Returns: 249 An object of the form: 250 251 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 252 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 253 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 254 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 255 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 256 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 257 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 258 { 259 "code": "A String", # [Output Only] The error type identifier for this error. 260 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 261 "message": "A String", # [Output Only] An optional, human-readable error message. 262 }, 263 ], 264 }, 265 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 266 "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. 267 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 268 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 269 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 270 "name": "A String", # [Output Only] Name of the operation. 271 "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. 272 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 273 "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. 274 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 275 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 276 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 277 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 278 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 279 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 280 "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. 281 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 282 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 283 { 284 "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. 285 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 286 { 287 "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). 288 "value": "A String", # [Output Only] A warning data value corresponding to the key. 289 }, 290 ], 291 "message": "A String", # [Output Only] A human-readable description of the warning code. 292 }, 293 ], 294 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 295}</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="close">close()</code> 300 <pre>Close httplib2 connections.</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 305 <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. 306 307Args: 308 project: string, Project ID for this request. (required) 309 region: string, The name of the region where the managed instance group is located. It should conform to RFC1035. (required) 310 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 311 body: object, The request body. 312 The object takes the form of: 313 314{ # RegionInstanceGroupManagers.createInstances 315 "instances": [ # [Required] List of specifications of per-instance configs. 316 { 317 "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. 318 "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. 319 "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. 320 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 321 "a_key": { 322 "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. 323 "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. 324 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 325 }, 326 }, 327 "metadata": { # Preserved metadata defined for this instance. 328 "a_key": "A String", 329 }, 330 }, 331 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 332 }, 333 ], 334} 335 336 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). 337 x__xgafv: string, V1 error format. 338 Allowed values 339 1 - v1 error format 340 2 - v2 error format 341 342Returns: 343 An object of the form: 344 345 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 346 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 347 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 348 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 349 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 350 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 351 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 352 { 353 "code": "A String", # [Output Only] The error type identifier for this error. 354 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 355 "message": "A String", # [Output Only] An optional, human-readable error message. 356 }, 357 ], 358 }, 359 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 360 "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. 361 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 362 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 363 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 364 "name": "A String", # [Output Only] Name of the operation. 365 "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. 366 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 367 "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. 368 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 369 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 370 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 371 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 372 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 373 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 374 "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. 375 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 376 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 377 { 378 "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. 379 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 380 { 381 "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). 382 "value": "A String", # [Output Only] A warning data value corresponding to the key. 383 }, 384 ], 385 "message": "A String", # [Output Only] A human-readable description of the warning code. 386 }, 387 ], 388 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 389}</pre> 390</div> 391 392<div class="method"> 393 <code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</code> 394 <pre>Deletes the specified managed instance group and all of the instances in that group. 395 396Args: 397 project: string, Project ID for this request. (required) 398 region: string, Name of the region scoping this request. (required) 399 instanceGroupManager: string, Name of the managed instance group to delete. (required) 400 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). 401 x__xgafv: string, V1 error format. 402 Allowed values 403 1 - v1 error format 404 2 - v2 error format 405 406Returns: 407 An object of the form: 408 409 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 410 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 411 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 412 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 413 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 414 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 415 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 416 { 417 "code": "A String", # [Output Only] The error type identifier for this error. 418 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 419 "message": "A String", # [Output Only] An optional, human-readable error message. 420 }, 421 ], 422 }, 423 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 424 "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. 425 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 426 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 427 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 428 "name": "A String", # [Output Only] Name of the operation. 429 "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. 430 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 431 "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. 432 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 433 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 434 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 435 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 436 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 437 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 438 "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. 439 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 440 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 441 { 442 "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. 443 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 444 { 445 "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). 446 "value": "A String", # [Output Only] A warning data value corresponding to the key. 447 }, 448 ], 449 "message": "A String", # [Output Only] A human-readable description of the warning code. 450 }, 451 ], 452 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 453}</pre> 454</div> 455 456<div class="method"> 457 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 458 <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. 459 460Args: 461 project: string, Project ID for this request. (required) 462 region: string, Name of the region scoping this request. (required) 463 instanceGroupManager: string, Name of the managed instance group. (required) 464 body: object, The request body. 465 The object takes the form of: 466 467{ 468 "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]. 469 "A String", 470 ], 471 "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. 472} 473 474 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). 475 x__xgafv: string, V1 error format. 476 Allowed values 477 1 - v1 error format 478 2 - v2 error format 479 480Returns: 481 An object of the form: 482 483 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 484 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 485 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 486 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 487 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 488 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 489 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 490 { 491 "code": "A String", # [Output Only] The error type identifier for this error. 492 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 493 "message": "A String", # [Output Only] An optional, human-readable error message. 494 }, 495 ], 496 }, 497 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 498 "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. 499 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 500 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 501 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 502 "name": "A String", # [Output Only] Name of the operation. 503 "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. 504 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 505 "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. 506 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 507 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 508 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 509 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 510 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 511 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 512 "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. 513 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 514 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 515 { 516 "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. 517 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 518 { 519 "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). 520 "value": "A String", # [Output Only] A warning data value corresponding to the key. 521 }, 522 ], 523 "message": "A String", # [Output Only] A human-readable description of the warning code. 524 }, 525 ], 526 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 527}</pre> 528</div> 529 530<div class="method"> 531 <code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> 532 <pre>Deletes selected per-instance configs for the managed instance group. 533 534Args: 535 project: string, Project ID for this request. (required) 536 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 537 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 538 body: object, The request body. 539 The object takes the form of: 540 541{ # RegionInstanceGroupManagers.deletePerInstanceConfigs 542 "names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group. 543 "A String", 544 ], 545} 546 547 x__xgafv: string, V1 error format. 548 Allowed values 549 1 - v1 error format 550 2 - v2 error format 551 552Returns: 553 An object of the form: 554 555 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 556 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 557 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 558 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 559 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 560 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 561 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 562 { 563 "code": "A String", # [Output Only] The error type identifier for this error. 564 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 565 "message": "A String", # [Output Only] An optional, human-readable error message. 566 }, 567 ], 568 }, 569 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 570 "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. 571 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 572 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 573 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 574 "name": "A String", # [Output Only] Name of the operation. 575 "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. 576 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 577 "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. 578 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 579 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 580 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 581 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 582 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 583 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 584 "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. 585 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 586 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 587 { 588 "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. 589 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 590 { 591 "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). 592 "value": "A String", # [Output Only] A warning data value corresponding to the key. 593 }, 594 ], 595 "message": "A String", # [Output Only] A human-readable description of the warning code. 596 }, 597 ], 598 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 599}</pre> 600</div> 601 602<div class="method"> 603 <code class="details" id="get">get(project, region, instanceGroupManager, x__xgafv=None)</code> 604 <pre>Returns all of the details about the specified managed instance group. 605 606Args: 607 project: string, Project ID for this request. (required) 608 region: string, Name of the region scoping this request. (required) 609 instanceGroupManager: string, Name of the managed instance group to return. (required) 610 x__xgafv: string, V1 error format. 611 Allowed values 612 1 - v1 error format 613 2 - v2 error format 614 615Returns: 616 An object of the form: 617 618 { # 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. 619 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 620 { 621 "healthCheck": "A String", # The URL for the health check that signals autohealing. 622 "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]. 623 }, 624 ], 625 "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. 626 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 627 "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. 628 "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. 629 "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. 630 "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. 631 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 632 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 633 "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. 634 "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. 635 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 636 "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. 637 }, 638 "description": "A String", # An optional description of this resource. 639 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 640 "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). 641 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 642 { 643 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 644 }, 645 ], 646 }, 647 "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. 648 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 649 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 650 "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. 651 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 652 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 653 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 654 { # The named port. For example: <"http", 80>. 655 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 656 "port": 42, # The port number, which can be a value between 1 and 65535. 657 }, 658 ], 659 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 660 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 661 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 662 "preservedState": { # Configuration of preserved resources. 663 "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. 664 "a_key": { 665 "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. 666 }, 667 }, 668 }, 669 }, 670 "status": { # [Output Only] The status of this managed instance group. 671 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 672 "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. 673 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 674 "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. 675 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 676 "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. 677 }, 678 }, 679 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 680 "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. 681 }, 682 }, 683 "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. 684 "A String", 685 ], 686 "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. 687 "updatePolicy": { # The update policy for this managed instance group. 688 "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. 689 "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. 690 "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. 691 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 692 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 693 }, 694 "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. 695 "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. 696 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 697 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 698 }, 699 "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. 700 "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. 701 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 702 "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). 703 }, 704 "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. 705 { 706 "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. 707 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 708 "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. 709 "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. 710 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 711 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 712 }, 713 }, 714 ], 715 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 716}</pre> 717</div> 718 719<div class="method"> 720 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 721 <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. 722 723Args: 724 project: string, Project ID for this request. (required) 725 region: string, Name of the region scoping this request. (required) 726 body: object, The request body. 727 The object takes the form of: 728 729{ # 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. 730 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 731 { 732 "healthCheck": "A String", # The URL for the health check that signals autohealing. 733 "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]. 734 }, 735 ], 736 "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. 737 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 738 "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. 739 "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. 740 "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. 741 "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. 742 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 743 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 744 "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. 745 "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. 746 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 747 "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. 748 }, 749 "description": "A String", # An optional description of this resource. 750 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 751 "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). 752 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 753 { 754 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 755 }, 756 ], 757 }, 758 "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. 759 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 760 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 761 "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. 762 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 763 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 764 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 765 { # The named port. For example: <"http", 80>. 766 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 767 "port": 42, # The port number, which can be a value between 1 and 65535. 768 }, 769 ], 770 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 771 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 772 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 773 "preservedState": { # Configuration of preserved resources. 774 "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. 775 "a_key": { 776 "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. 777 }, 778 }, 779 }, 780 }, 781 "status": { # [Output Only] The status of this managed instance group. 782 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 783 "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. 784 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 785 "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. 786 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 787 "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. 788 }, 789 }, 790 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 791 "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. 792 }, 793 }, 794 "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. 795 "A String", 796 ], 797 "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. 798 "updatePolicy": { # The update policy for this managed instance group. 799 "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. 800 "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. 801 "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. 802 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 803 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 804 }, 805 "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. 806 "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. 807 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 808 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 809 }, 810 "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. 811 "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. 812 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 813 "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). 814 }, 815 "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. 816 { 817 "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. 818 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 819 "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. 820 "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. 821 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 822 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 823 }, 824 }, 825 ], 826 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 827} 828 829 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). 830 x__xgafv: string, V1 error format. 831 Allowed values 832 1 - v1 error format 833 2 - v2 error format 834 835Returns: 836 An object of the form: 837 838 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 839 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 840 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 841 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 842 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 843 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 844 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 845 { 846 "code": "A String", # [Output Only] The error type identifier for this error. 847 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 848 "message": "A String", # [Output Only] An optional, human-readable error message. 849 }, 850 ], 851 }, 852 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 853 "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. 854 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 855 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 856 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 857 "name": "A String", # [Output Only] Name of the operation. 858 "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. 859 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 860 "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. 861 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 862 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 863 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 864 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 865 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 866 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 867 "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. 868 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 869 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 870 { 871 "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. 872 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 873 { 874 "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). 875 "value": "A String", # [Output Only] A warning data value corresponding to the key. 876 }, 877 ], 878 "message": "A String", # [Output Only] A human-readable description of the warning code. 879 }, 880 ], 881 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 882}</pre> 883</div> 884 885<div class="method"> 886 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 887 <pre>Retrieves the list of managed instance groups that are contained within the specified region. 888 889Args: 890 project: string, Project ID for this request. (required) 891 region: string, Name of the region scoping this request. (required) 892 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) ``` 893 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`) 894 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. 895 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. 896 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 897 x__xgafv: string, V1 error format. 898 Allowed values 899 1 - v1 error format 900 2 - v2 error format 901 902Returns: 903 An object of the form: 904 905 { # Contains a list of managed instance groups. 906 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 907 "items": [ # A list of InstanceGroupManager resources. 908 { # 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. 909 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 910 { 911 "healthCheck": "A String", # The URL for the health check that signals autohealing. 912 "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]. 913 }, 914 ], 915 "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. 916 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 917 "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. 918 "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. 919 "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. 920 "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. 921 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 922 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 923 "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. 924 "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. 925 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 926 "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. 927 }, 928 "description": "A String", # An optional description of this resource. 929 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 930 "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). 931 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 932 { 933 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 934 }, 935 ], 936 }, 937 "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. 938 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 939 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 940 "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. 941 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 942 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 943 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 944 { # The named port. For example: <"http", 80>. 945 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 946 "port": 42, # The port number, which can be a value between 1 and 65535. 947 }, 948 ], 949 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 950 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 951 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 952 "preservedState": { # Configuration of preserved resources. 953 "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. 954 "a_key": { 955 "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. 956 }, 957 }, 958 }, 959 }, 960 "status": { # [Output Only] The status of this managed instance group. 961 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 962 "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. 963 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 964 "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. 965 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 966 "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. 967 }, 968 }, 969 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 970 "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. 971 }, 972 }, 973 "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. 974 "A String", 975 ], 976 "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. 977 "updatePolicy": { # The update policy for this managed instance group. 978 "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. 979 "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. 980 "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. 981 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 982 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 983 }, 984 "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. 985 "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. 986 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 987 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 988 }, 989 "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. 990 "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. 991 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 992 "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). 993 }, 994 "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. 995 { 996 "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. 997 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 998 "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. 999 "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. 1000 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1001 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1002 }, 1003 }, 1004 ], 1005 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1006 }, 1007 ], 1008 "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. 1009 "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. 1010 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1011 "warning": { # [Output Only] Informational warning message. 1012 "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. 1013 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1014 { 1015 "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). 1016 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1017 }, 1018 ], 1019 "message": "A String", # [Output Only] A human-readable description of the warning code. 1020 }, 1021}</pre> 1022</div> 1023 1024<div class="method"> 1025 <code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1026 <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. 1027 1028Args: 1029 project: string, Project ID for this request. (required) 1030 region: string, Name of the region scoping this request. This should conform to RFC1035. (required) 1031 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) 1032 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) ``` 1033 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`) 1034 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. 1035 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. 1036 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1037 x__xgafv: string, V1 error format. 1038 Allowed values 1039 1 - v1 error format 1040 2 - v2 error format 1041 1042Returns: 1043 An object of the form: 1044 1045 { 1046 "items": [ # [Output Only] The list of errors of the managed instance group. 1047 { 1048 "error": { # [Output Only] Contents of the error. 1049 "code": "A String", # [Output Only] Error code. 1050 "message": "A String", # [Output Only] Error message. 1051 }, 1052 "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. 1053 "action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: 1054 "instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created. 1055 "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. 1056 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1057 "name": "A String", # [Output Only] Name of the version. 1058 }, 1059 }, 1060 "timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format. 1061 }, 1062 ], 1063 "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. 1064}</pre> 1065</div> 1066 1067<div class="method"> 1068 <code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code> 1069 <pre>Retrieves the next page of results. 1070 1071Args: 1072 previous_request: The request for the previous page. (required) 1073 previous_response: The response from the request for the previous page. (required) 1074 1075Returns: 1076 A request object that you can call 'execute()' on to request the next 1077 page. Returns None if there are no more items in the collection. 1078 </pre> 1079</div> 1080 1081<div class="method"> 1082 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1083 <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. 1084 1085Args: 1086 project: string, Project ID for this request. (required) 1087 region: string, Name of the region scoping this request. (required) 1088 instanceGroupManager: string, The name of the managed instance group. (required) 1089 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) ``` 1090 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`) 1091 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. 1092 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. 1093 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1094 x__xgafv: string, V1 error format. 1095 Allowed values 1096 1 - v1 error format 1097 2 - v2 error format 1098 1099Returns: 1100 An object of the form: 1101 1102 { 1103 "managedInstances": [ # A list of managed instances. 1104 { # A Managed Instance resource. 1105 "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. 1106 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist. 1107 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. 1108 "instanceHealth": [ # [Output Only] Health state of the instance per health-check. 1109 { 1110 "detailedHealthState": "A String", # [Output Only] The current detailed instance health state. 1111 "healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy. 1112 }, 1113 ], 1114 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist. 1115 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance. 1116 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance. 1117 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1118 { 1119 "code": "A String", # [Output Only] The error type identifier for this error. 1120 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1121 "message": "A String", # [Output Only] An optional, human-readable error message. 1122 }, 1123 ], 1124 }, 1125 }, 1126 "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance. 1127 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1128 "a_key": { 1129 "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. 1130 "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. 1131 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1132 }, 1133 }, 1134 "metadata": { # Preserved metadata defined for this instance. 1135 "a_key": "A String", 1136 }, 1137 }, 1138 "preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy for this instance. 1139 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1140 "a_key": { 1141 "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. 1142 "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. 1143 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1144 }, 1145 }, 1146 "metadata": { # Preserved metadata defined for this instance. 1147 "a_key": "A String", 1148 }, 1149 }, 1150 "version": { # [Output Only] Intended version of this instance. 1151 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 1152 "name": "A String", # [Output Only] Name of the version. 1153 }, 1154 }, 1155 ], 1156 "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. 1157}</pre> 1158</div> 1159 1160<div class="method"> 1161 <code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code> 1162 <pre>Retrieves the next page of results. 1163 1164Args: 1165 previous_request: The request for the previous page. (required) 1166 previous_response: The response from the request for the previous page. (required) 1167 1168Returns: 1169 A request object that you can call 'execute()' on to request the next 1170 page. Returns None if there are no more items in the collection. 1171 </pre> 1172</div> 1173 1174<div class="method"> 1175 <code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1176 <pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported. 1177 1178Args: 1179 project: string, Project ID for this request. (required) 1180 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 1181 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1182 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) ``` 1183 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`) 1184 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. 1185 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. 1186 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1187 x__xgafv: string, V1 error format. 1188 Allowed values 1189 1 - v1 error format 1190 2 - v2 error format 1191 1192Returns: 1193 An object of the form: 1194 1195 { 1196 "items": [ # [Output Only] The list of PerInstanceConfig. 1197 { 1198 "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. 1199 "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. 1200 "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. 1201 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1202 "a_key": { 1203 "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. 1204 "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. 1205 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1206 }, 1207 }, 1208 "metadata": { # Preserved metadata defined for this instance. 1209 "a_key": "A String", 1210 }, 1211 }, 1212 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1213 }, 1214 ], 1215 "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. 1216 "warning": { # [Output Only] Informational warning message. 1217 "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. 1218 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1219 { 1220 "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). 1221 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1222 }, 1223 ], 1224 "message": "A String", # [Output Only] A human-readable description of the warning code. 1225 }, 1226}</pre> 1227</div> 1228 1229<div class="method"> 1230 <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code> 1231 <pre>Retrieves the next page of results. 1232 1233Args: 1234 previous_request: The request for the previous page. (required) 1235 previous_response: The response from the request for the previous page. (required) 1236 1237Returns: 1238 A request object that you can call 'execute()' on to request the next 1239 page. Returns None if there are no more items in the collection. 1240 </pre> 1241</div> 1242 1243<div class="method"> 1244 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1245 <pre>Retrieves the next page of results. 1246 1247Args: 1248 previous_request: The request for the previous page. (required) 1249 previous_response: The response from the request for the previous page. (required) 1250 1251Returns: 1252 A request object that you can call 'execute()' on to request the next 1253 page. Returns None if there are no more items in the collection. 1254 </pre> 1255</div> 1256 1257<div class="method"> 1258 <code class="details" id="patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1259 <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. 1260 1261Args: 1262 project: string, Project ID for this request. (required) 1263 region: string, Name of the region scoping this request. (required) 1264 instanceGroupManager: string, The name of the instance group manager. (required) 1265 body: object, The request body. 1266 The object takes the form of: 1267 1268{ # 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. 1269 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1270 { 1271 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1272 "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]. 1273 }, 1274 ], 1275 "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. 1276 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1277 "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. 1278 "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. 1279 "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. 1280 "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. 1281 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1282 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1283 "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. 1284 "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. 1285 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1286 "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. 1287 }, 1288 "description": "A String", # An optional description of this resource. 1289 "distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. 1290 "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). 1291 "zones": [ # Zones where the regional managed instance group will create and manage its instances. 1292 { 1293 "zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located. 1294 }, 1295 ], 1296 }, 1297 "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. 1298 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1299 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1300 "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. 1301 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1302 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1303 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1304 { # The named port. For example: <"http", 80>. 1305 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1306 "port": 42, # The port number, which can be a value between 1 and 65535. 1307 }, 1308 ], 1309 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1310 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1311 "statefulPolicy": { # Stateful configuration for this Instanced Group Manager 1312 "preservedState": { # Configuration of preserved resources. 1313 "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. 1314 "a_key": { 1315 "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. 1316 }, 1317 }, 1318 }, 1319 }, 1320 "status": { # [Output Only] The status of this managed instance group. 1321 "autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager. 1322 "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. 1323 "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. 1324 "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. 1325 "perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance. 1326 "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. 1327 }, 1328 }, 1329 "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. 1330 "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. 1331 }, 1332 }, 1333 "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. 1334 "A String", 1335 ], 1336 "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. 1337 "updatePolicy": { # The update policy for this managed instance group. 1338 "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. 1339 "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. 1340 "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. 1341 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1342 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1343 }, 1344 "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. 1345 "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. 1346 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1347 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1348 }, 1349 "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. 1350 "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. 1351 "replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE 1352 "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). 1353 }, 1354 "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. 1355 { 1356 "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. 1357 "name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group. 1358 "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. 1359 "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. 1360 "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. 1361 "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. 1362 }, 1363 }, 1364 ], 1365 "zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). 1366} 1367 1368 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). 1369 x__xgafv: string, V1 error format. 1370 Allowed values 1371 1 - v1 error format 1372 2 - v2 error format 1373 1374Returns: 1375 An object of the form: 1376 1377 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1378 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1379 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1380 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1381 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1382 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1383 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1384 { 1385 "code": "A String", # [Output Only] The error type identifier for this error. 1386 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1387 "message": "A String", # [Output Only] An optional, human-readable error message. 1388 }, 1389 ], 1390 }, 1391 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1392 "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. 1393 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1394 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1395 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1396 "name": "A String", # [Output Only] Name of the operation. 1397 "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. 1398 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1399 "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. 1400 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1401 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1402 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1403 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1404 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1405 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1406 "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. 1407 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1408 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1409 { 1410 "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. 1411 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1412 { 1413 "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). 1414 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1415 }, 1416 ], 1417 "message": "A String", # [Output Only] A human-readable description of the warning code. 1418 }, 1419 ], 1420 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1421}</pre> 1422</div> 1423 1424<div class="method"> 1425 <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1426 <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. 1427 1428Args: 1429 project: string, Project ID for this request. (required) 1430 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 1431 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1432 body: object, The request body. 1433 The object takes the form of: 1434 1435{ # RegionInstanceGroupManagers.patchPerInstanceConfigs 1436 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 1437 { 1438 "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. 1439 "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. 1440 "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. 1441 "disks": { # Preserved disks defined for this instance. 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, 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. 1444 "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. 1445 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1446 }, 1447 }, 1448 "metadata": { # Preserved metadata defined for this instance. 1449 "a_key": "A String", 1450 }, 1451 }, 1452 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1453 }, 1454 ], 1455} 1456 1457 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). 1458 x__xgafv: string, V1 error format. 1459 Allowed values 1460 1 - v1 error format 1461 2 - v2 error format 1462 1463Returns: 1464 An object of the form: 1465 1466 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1467 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1468 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1469 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1470 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1471 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1472 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1473 { 1474 "code": "A String", # [Output Only] The error type identifier for this error. 1475 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1476 "message": "A String", # [Output Only] An optional, human-readable error message. 1477 }, 1478 ], 1479 }, 1480 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1481 "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. 1482 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1483 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1484 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1485 "name": "A String", # [Output Only] Name of the operation. 1486 "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. 1487 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1488 "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. 1489 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1490 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1491 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1492 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1493 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1494 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1495 "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. 1496 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1497 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1498 { 1499 "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. 1500 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1501 { 1502 "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). 1503 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1504 }, 1505 ], 1506 "message": "A String", # [Output Only] A human-readable description of the warning code. 1507 }, 1508 ], 1509 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1510}</pre> 1511</div> 1512 1513<div class="method"> 1514 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1515 <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. 1516 1517Args: 1518 project: string, Project ID for this request. (required) 1519 region: string, Name of the region scoping this request. (required) 1520 instanceGroupManager: string, Name of the managed instance group. (required) 1521 body: object, The request body. 1522 The object takes the form of: 1523 1524{ 1525 "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]. 1526 "A String", 1527 ], 1528} 1529 1530 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). 1531 x__xgafv: string, V1 error format. 1532 Allowed values 1533 1 - v1 error format 1534 2 - v2 error format 1535 1536Returns: 1537 An object of the form: 1538 1539 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1540 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1541 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1542 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1543 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1544 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1545 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1546 { 1547 "code": "A String", # [Output Only] The error type identifier for this error. 1548 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1549 "message": "A String", # [Output Only] An optional, human-readable error message. 1550 }, 1551 ], 1552 }, 1553 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1554 "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. 1555 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1556 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1557 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1558 "name": "A String", # [Output Only] Name of the operation. 1559 "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. 1560 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1561 "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. 1562 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1563 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1564 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1565 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1566 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1567 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1568 "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. 1569 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1570 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1571 { 1572 "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. 1573 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1574 { 1575 "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). 1576 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1577 }, 1578 ], 1579 "message": "A String", # [Output Only] A human-readable description of the warning code. 1580 }, 1581 ], 1582 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1583}</pre> 1584</div> 1585 1586<div class="method"> 1587 <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code> 1588 <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. 1589 1590Args: 1591 project: string, Project ID for this request. (required) 1592 region: string, Name of the region scoping this request. (required) 1593 instanceGroupManager: string, Name of the managed instance group. (required) 1594 size: integer, Number of instances that should exist in this instance group manager. (required) 1595 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). 1596 x__xgafv: string, V1 error format. 1597 Allowed values 1598 1 - v1 error format 1599 2 - v2 error format 1600 1601Returns: 1602 An object of the form: 1603 1604 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1605 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1606 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1607 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1608 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1609 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1610 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1611 { 1612 "code": "A String", # [Output Only] The error type identifier for this error. 1613 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1614 "message": "A String", # [Output Only] An optional, human-readable error message. 1615 }, 1616 ], 1617 }, 1618 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1619 "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. 1620 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1621 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1622 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1623 "name": "A String", # [Output Only] Name of the operation. 1624 "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. 1625 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1626 "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. 1627 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1628 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1629 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1630 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1631 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1632 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1633 "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. 1634 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1635 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1636 { 1637 "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. 1638 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1639 { 1640 "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). 1641 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1642 }, 1643 ], 1644 "message": "A String", # [Output Only] A human-readable description of the warning code. 1645 }, 1646 ], 1647 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1648}</pre> 1649</div> 1650 1651<div class="method"> 1652 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1653 <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. 1654 1655Args: 1656 project: string, Project ID for this request. (required) 1657 region: string, Name of the region scoping this request. (required) 1658 instanceGroupManager: string, The name of the managed instance group. (required) 1659 body: object, The request body. 1660 The object takes the form of: 1661 1662{ 1663 "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created. 1664} 1665 1666 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). 1667 x__xgafv: string, V1 error format. 1668 Allowed values 1669 1 - v1 error format 1670 2 - v2 error format 1671 1672Returns: 1673 An object of the form: 1674 1675 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1676 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1677 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1678 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1679 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1680 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1681 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1682 { 1683 "code": "A String", # [Output Only] The error type identifier for this error. 1684 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1685 "message": "A String", # [Output Only] An optional, human-readable error message. 1686 }, 1687 ], 1688 }, 1689 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1690 "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. 1691 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1692 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1693 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1694 "name": "A String", # [Output Only] Name of the operation. 1695 "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. 1696 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1697 "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. 1698 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1699 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1700 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1701 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1702 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1703 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1704 "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. 1705 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1706 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1707 { 1708 "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. 1709 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1710 { 1711 "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). 1712 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1713 }, 1714 ], 1715 "message": "A String", # [Output Only] A human-readable description of the warning code. 1716 }, 1717 ], 1718 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1719}</pre> 1720</div> 1721 1722<div class="method"> 1723 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1724 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. 1725 1726Args: 1727 project: string, Project ID for this request. (required) 1728 region: string, Name of the region scoping this request. (required) 1729 instanceGroupManager: string, Name of the managed instance group. (required) 1730 body: object, The request body. 1731 The object takes the form of: 1732 1733{ 1734 "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. 1735 "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. 1736 "A String", 1737 ], 1738} 1739 1740 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). 1741 x__xgafv: string, V1 error format. 1742 Allowed values 1743 1 - v1 error format 1744 2 - v2 error format 1745 1746Returns: 1747 An object of the form: 1748 1749 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1750 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1751 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1752 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1753 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1754 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1755 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1756 { 1757 "code": "A String", # [Output Only] The error type identifier for this error. 1758 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1759 "message": "A String", # [Output Only] An optional, human-readable error message. 1760 }, 1761 ], 1762 }, 1763 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1764 "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. 1765 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1766 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1767 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1768 "name": "A String", # [Output Only] Name of the operation. 1769 "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. 1770 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1771 "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. 1772 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1773 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1774 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1775 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1776 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1777 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1778 "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. 1779 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1780 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1781 { 1782 "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. 1783 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1784 { 1785 "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). 1786 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1787 }, 1788 ], 1789 "message": "A String", # [Output Only] A human-readable description of the warning code. 1790 }, 1791 ], 1792 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1793}</pre> 1794</div> 1795 1796<div class="method"> 1797 <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> 1798 <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. 1799 1800Args: 1801 project: string, Project ID for this request. (required) 1802 region: string, Name of the region scoping this request, should conform to RFC1035. (required) 1803 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) 1804 body: object, The request body. 1805 The object takes the form of: 1806 1807{ # RegionInstanceGroupManagers.updatePerInstanceConfigs 1808 "perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group. 1809 { 1810 "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. 1811 "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. 1812 "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. 1813 "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. 1814 "a_key": { 1815 "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. 1816 "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. 1817 "source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance. 1818 }, 1819 }, 1820 "metadata": { # Preserved metadata defined for this instance. 1821 "a_key": "A String", 1822 }, 1823 }, 1824 "status": "A String", # The status of applying this per-instance config on the corresponding managed instance. 1825 }, 1826 ], 1827} 1828 1829 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). 1830 x__xgafv: string, V1 error format. 1831 Allowed values 1832 1 - v1 error format 1833 2 - v2 error format 1834 1835Returns: 1836 An object of the form: 1837 1838 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1839 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1840 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1841 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1842 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1843 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1844 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1845 { 1846 "code": "A String", # [Output Only] The error type identifier for this error. 1847 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1848 "message": "A String", # [Output Only] An optional, human-readable error message. 1849 }, 1850 ], 1851 }, 1852 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1853 "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. 1854 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1855 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1856 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1857 "name": "A String", # [Output Only] Name of the operation. 1858 "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. 1859 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1860 "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. 1861 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1862 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1863 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1864 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1865 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1866 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1867 "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. 1868 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1869 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1870 { 1871 "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. 1872 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1873 { 1874 "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). 1875 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1876 }, 1877 ], 1878 "message": "A String", # [Output Only] A human-readable description of the warning code. 1879 }, 1880 ], 1881 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1882}</pre> 1883</div> 1884 1885</body></html>