1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</a></code></p> 79 <p class="firstline">Schedules a group action to remove the specified instances 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.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(project, region, instanceGroupManager)</a></code></p> 82 <p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p> 83 <p class="toc_element"> 84 <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</a></code></p> 85 <p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p> 86 <p class="toc_element"> 87 <code><a href="#get">get(project, region, instanceGroupManager)</a></code></p> 88 <p class="firstline">Returns all of the details about the specified managed instance group.</p> 89 <p class="toc_element"> 90 <code><a href="#insert">insert(project, region, body)</a></code></p> 91 <p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group 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.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94 <p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p> 95 <p class="toc_element"> 96 <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, order_by=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97 <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.</p> 98 <p class="toc_element"> 99 <code><a href="#listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</a></code></p> 100 <p class="firstline">Retrieves the next page of results.</p> 101 <p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103 <p class="firstline">Retrieves the next page of results.</p> 104 <p class="toc_element"> 105 <code><a href="#patch">patch(project, region, instanceGroupManager, body)</a></code></p> 106 <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.</p> 107 <p class="toc_element"> 108 <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</a></code></p> 109 <p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p> 110 <p class="toc_element"> 111 <code><a href="#resize">resize(project, region, instanceGroupManager, size)</a></code></p> 112 <p class="firstline">Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p> 113 <p class="toc_element"> 114 <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</a></code></p> 115 <p class="firstline">Modifies the autohealing policy for the instances in this managed instance group.</p> 116 <p class="toc_element"> 117 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</a></code></p> 118 <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> 119 <p class="toc_element"> 120 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</a></code></p> 121 <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> 122 <p class="toc_element"> 123 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 124 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 125 <p class="toc_element"> 126 <code><a href="#update">update(project, region, instanceGroupManager, body)</a></code></p> 127 <p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p> 128 <h3>Method Details</h3> 129 <div class="method"> 130 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</code> 131 <pre>Schedules a group action to remove the specified instances 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. 132 133 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. 134 135 You can specify a maximum of 1000 instances with this method per request. 136 137 Args: 138 project: string, Project ID for this request. (required) 139 region: string, Name of the region scoping this request. (required) 140 instanceGroupManager: string, Name of the managed instance group. (required) 141 body: object, The request body. (required) 142 The object takes the form of: 143 144 { 145 "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]. 146 "A String", 147 ], 148 } 149 150 151 Returns: 152 An object of the form: 153 154 { # An Operation resource, used to manage asynchronous API requests. 155 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 156 "clientOperationId": "A String", # [Output Only] Reserved for future use. 157 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 158 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 159 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 160 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 161 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 162 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 163 "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. 164 "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. 165 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 166 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 167 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 168 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 169 { 170 "message": "A String", # [Output Only] A human-readable description of the warning code. 171 "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. 172 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 173 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 174 { 175 "value": "A String", # [Output Only] A warning data value corresponding to the key. 176 "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). 177 }, 178 ], 179 }, 180 ], 181 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 182 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 183 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 184 "name": "A String", # [Output Only] Name of the resource. 185 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 186 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 187 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 188 { 189 "message": "A String", # [Output Only] An optional, human-readable error message. 190 "code": "A String", # [Output Only] The error type identifier for this error. 191 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 192 }, 193 ], 194 }, 195 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 196 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 197 "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. 198 }</pre> 199 </div> 200 201 <div class="method"> 202 <code class="details" id="delete">delete(project, region, instanceGroupManager)</code> 203 <pre>Deletes the specified managed instance group and all of the instances in that group. 204 205 Args: 206 project: string, Project ID for this request. (required) 207 region: string, Name of the region scoping this request. (required) 208 instanceGroupManager: string, Name of the managed instance group to delete. (required) 209 210 Returns: 211 An object of the form: 212 213 { # An Operation resource, used to manage asynchronous API requests. 214 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 215 "clientOperationId": "A String", # [Output Only] Reserved for future use. 216 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 217 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 218 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 219 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 220 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 221 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 222 "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. 223 "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. 224 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 225 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 226 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 227 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 228 { 229 "message": "A String", # [Output Only] A human-readable description of the warning code. 230 "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. 231 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 232 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 233 { 234 "value": "A String", # [Output Only] A warning data value corresponding to the key. 235 "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). 236 }, 237 ], 238 }, 239 ], 240 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 241 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 242 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 243 "name": "A String", # [Output Only] Name of the resource. 244 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 245 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 246 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 247 { 248 "message": "A String", # [Output Only] An optional, human-readable error message. 249 "code": "A String", # [Output Only] The error type identifier for this error. 250 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 251 }, 252 ], 253 }, 254 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 255 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 256 "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. 257 }</pre> 258 </div> 259 260 <div class="method"> 261 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</code> 262 <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 263 264 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. 265 266 You can specify a maximum of 1000 instances with this method per request. 267 268 Args: 269 project: string, Project ID for this request. (required) 270 region: string, Name of the region scoping this request. (required) 271 instanceGroupManager: string, Name of the managed instance group. (required) 272 body: object, The request body. (required) 273 The object takes the form of: 274 275 { 276 "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]. 277 "A String", 278 ], 279 } 280 281 282 Returns: 283 An object of the form: 284 285 { # An Operation resource, used to manage asynchronous API requests. 286 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 287 "clientOperationId": "A String", # [Output Only] Reserved for future use. 288 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 289 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 290 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 291 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 292 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 293 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 294 "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. 295 "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. 296 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 297 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 298 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 299 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 300 { 301 "message": "A String", # [Output Only] A human-readable description of the warning code. 302 "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. 303 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 304 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 305 { 306 "value": "A String", # [Output Only] A warning data value corresponding to the key. 307 "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). 308 }, 309 ], 310 }, 311 ], 312 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 313 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 314 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 315 "name": "A String", # [Output Only] Name of the resource. 316 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 317 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 318 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 319 { 320 "message": "A String", # [Output Only] An optional, human-readable error message. 321 "code": "A String", # [Output Only] The error type identifier for this error. 322 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 323 }, 324 ], 325 }, 326 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 327 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 328 "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. 329 }</pre> 330 </div> 331 332 <div class="method"> 333 <code class="details" id="get">get(project, region, instanceGroupManager)</code> 334 <pre>Returns all of the details about the specified managed instance group. 335 336 Args: 337 project: string, Project ID for this request. (required) 338 region: string, Name of the region scoping this request. (required) 339 instanceGroupManager: string, Name of the managed instance group to return. (required) 340 341 Returns: 342 An object of the form: 343 344 { # An Instance Group Manager resource. 345 "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. 346 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 347 "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. 348 "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. 349 # 350 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 351 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 352 "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. 353 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 354 "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. 355 "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. 356 }, 357 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 358 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). 359 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 360 { 361 "healthCheck": "A String", # The URL for the health check that signals autohealing. 362 "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]. 363 }, 364 ], 365 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. 366 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 367 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 368 "serviceAccount": "A String", # Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used. 369 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 370 "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. 371 "A String", 372 ], 373 "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. 374 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. 375 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 376 "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. 377 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 378 { # The named port. For example: . 379 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 380 "port": 42, # The port number, which can be a value between 1 and 65535. 381 }, 382 ], 383 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 384 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 385 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 386 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 387 }</pre> 388 </div> 389 390 <div class="method"> 391 <code class="details" id="insert">insert(project, region, body)</code> 392 <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group 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. 393 394 A regional managed instance group can contain up to 2000 instances. 395 396 Args: 397 project: string, Project ID for this request. (required) 398 region: string, Name of the region scoping this request. (required) 399 body: object, The request body. (required) 400 The object takes the form of: 401 402 { # An Instance Group Manager resource. 403 "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. 404 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 405 "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. 406 "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. 407 # 408 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 409 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 410 "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. 411 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 412 "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. 413 "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. 414 }, 415 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 416 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). 417 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 418 { 419 "healthCheck": "A String", # The URL for the health check that signals autohealing. 420 "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]. 421 }, 422 ], 423 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. 424 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 425 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 426 "serviceAccount": "A String", # Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used. 427 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 428 "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. 429 "A String", 430 ], 431 "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. 432 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. 433 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 434 "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. 435 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 436 { # The named port. For example: . 437 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 438 "port": 42, # The port number, which can be a value between 1 and 65535. 439 }, 440 ], 441 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 442 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 443 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 444 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 445 } 446 447 448 Returns: 449 An object of the form: 450 451 { # An Operation resource, used to manage asynchronous API requests. 452 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 453 "clientOperationId": "A String", # [Output Only] Reserved for future use. 454 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 455 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 456 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 457 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 458 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 459 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 460 "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. 461 "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. 462 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 463 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 464 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 465 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 466 { 467 "message": "A String", # [Output Only] A human-readable description of the warning code. 468 "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. 469 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 470 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 471 { 472 "value": "A String", # [Output Only] A warning data value corresponding to the key. 473 "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). 474 }, 475 ], 476 }, 477 ], 478 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 479 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 480 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 481 "name": "A String", # [Output Only] Name of the resource. 482 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 483 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 484 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 485 { 486 "message": "A String", # [Output Only] An optional, human-readable error message. 487 "code": "A String", # [Output Only] The error type identifier for this error. 488 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 489 }, 490 ], 491 }, 492 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 493 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 494 "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. 495 }</pre> 496 </div> 497 498 <div class="method"> 499 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 500 <pre>Retrieves the list of managed instance groups that are contained within the specified region. 501 502 Args: 503 project: string, Project ID for this request. (required) 504 region: string, Name of the region scoping this request. (required) 505 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 506 507 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. 508 509 Currently, only sorting by name or creationTimestamp desc is supported. 510 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) 511 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. 512 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 513 514 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 515 516 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 517 518 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 519 520 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 521 522 Returns: 523 An object of the form: 524 525 { # Contains a list of managed instance groups. 526 "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request. 527 "items": [ # A list of managed instance groups. 528 { # An Instance Group Manager resource. 529 "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. 530 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 531 "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. 532 "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. 533 # 534 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 535 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 536 "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. 537 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 538 "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. 539 "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. 540 }, 541 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 542 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). 543 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 544 { 545 "healthCheck": "A String", # The URL for the health check that signals autohealing. 546 "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]. 547 }, 548 ], 549 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. 550 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 551 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 552 "serviceAccount": "A String", # Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used. 553 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 554 "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. 555 "A String", 556 ], 557 "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. 558 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. 559 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 560 "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. 561 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 562 { # The named port. For example: . 563 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 564 "port": 42, # The port number, which can be a value between 1 and 65535. 565 }, 566 ], 567 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 568 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 569 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 570 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 571 }, 572 ], 573 "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. 574 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 575 "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL. 576 }</pre> 577 </div> 578 579 <div class="method"> 580 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, order_by=None, maxResults=None, pageToken=None, filter=None)</code> 581 <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. 582 583 Args: 584 project: string, Project ID for this request. (required) 585 region: string, Name of the region scoping this request. (required) 586 instanceGroupManager: string, The name of the managed instance group. (required) 587 order_by: string, A parameter 588 maxResults: integer, A parameter 589 pageToken: string, A parameter 590 filter: string, A parameter 591 592 Returns: 593 An object of the form: 594 595 { 596 "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. 597 "managedInstances": [ # List of managed instances. 598 { 599 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist. 600 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance. 601 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance. 602 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 603 { 604 "message": "A String", # [Output Only] An optional, human-readable error message. 605 "code": "A String", # [Output Only] The error type identifier for this error. 606 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 607 }, 608 ], 609 }, 610 }, 611 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. 612 "version": { # [Output Only] Intended version of this instance. 613 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. 614 "name": "A String", # [Output Only] Name of the version. 615 }, 616 "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: 617 # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. 618 # - 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. 619 # - 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. 620 # - RECREATING The managed instance group is recreating this instance. 621 # - DELETING The managed instance group is permanently deleting this instance. 622 # - 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. 623 # - RESTARTING The managed instance group is restarting the instance. 624 # - 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. 625 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist. 626 }, 627 ], 628 }</pre> 629 </div> 630 631 <div class="method"> 632 <code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code> 633 <pre>Retrieves the next page of results. 634 635 Args: 636 previous_request: The request for the previous page. (required) 637 previous_response: The response from the request for the previous page. (required) 638 639 Returns: 640 A request object that you can call 'execute()' on to request the next 641 page. Returns None if there are no more items in the collection. 642 </pre> 643 </div> 644 645 <div class="method"> 646 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 647 <pre>Retrieves the next page of results. 648 649 Args: 650 previous_request: The request for the previous page. (required) 651 previous_response: The response from the request for the previous page. (required) 652 653 Returns: 654 A request object that you can call 'execute()' on to request the next 655 page. Returns None if there are no more items in the collection. 656 </pre> 657 </div> 658 659 <div class="method"> 660 <code class="details" id="patch">patch(project, region, instanceGroupManager, body)</code> 661 <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. 662 663 Args: 664 project: string, Project ID for this request. (required) 665 region: string, Name of the region scoping this request. (required) 666 instanceGroupManager: string, The name of the instance group manager. (required) 667 body: object, The request body. (required) 668 The object takes the form of: 669 670 { # An Instance Group Manager resource. 671 "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. 672 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 673 "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. 674 "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. 675 # 676 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 677 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 678 "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. 679 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 680 "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. 681 "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. 682 }, 683 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 684 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). 685 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 686 { 687 "healthCheck": "A String", # The URL for the health check that signals autohealing. 688 "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]. 689 }, 690 ], 691 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. 692 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 693 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 694 "serviceAccount": "A String", # Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used. 695 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 696 "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. 697 "A String", 698 ], 699 "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. 700 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. 701 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 702 "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. 703 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 704 { # The named port. For example: . 705 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 706 "port": 42, # The port number, which can be a value between 1 and 65535. 707 }, 708 ], 709 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 710 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 711 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 712 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 713 } 714 715 716 Returns: 717 An object of the form: 718 719 { # An Operation resource, used to manage asynchronous API requests. 720 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 721 "clientOperationId": "A String", # [Output Only] Reserved for future use. 722 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 723 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 724 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 725 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 726 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 727 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 728 "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. 729 "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. 730 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 731 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 732 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 733 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 734 { 735 "message": "A String", # [Output Only] A human-readable description of the warning code. 736 "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. 737 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 738 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 739 { 740 "value": "A String", # [Output Only] A warning data value corresponding to the key. 741 "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). 742 }, 743 ], 744 }, 745 ], 746 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 747 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 748 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 749 "name": "A String", # [Output Only] Name of the resource. 750 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 751 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 752 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 753 { 754 "message": "A String", # [Output Only] An optional, human-readable error message. 755 "code": "A String", # [Output Only] The error type identifier for this error. 756 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 757 }, 758 ], 759 }, 760 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 761 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 762 "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. 763 }</pre> 764 </div> 765 766 <div class="method"> 767 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</code> 768 <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. 769 770 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. 771 772 You can specify a maximum of 1000 instances with this method per request. 773 774 Args: 775 project: string, Project ID for this request. (required) 776 region: string, Name of the region scoping this request. (required) 777 instanceGroupManager: string, Name of the managed instance group. (required) 778 body: object, The request body. (required) 779 The object takes the form of: 780 781 { 782 "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]. 783 "A String", 784 ], 785 } 786 787 788 Returns: 789 An object of the form: 790 791 { # An Operation resource, used to manage asynchronous API requests. 792 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 793 "clientOperationId": "A String", # [Output Only] Reserved for future use. 794 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 795 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 796 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 797 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 798 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 799 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 800 "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. 801 "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. 802 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 803 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 804 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 805 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 806 { 807 "message": "A String", # [Output Only] A human-readable description of the warning code. 808 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 809 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 810 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 811 { 812 "value": "A String", # [Output Only] A warning data value corresponding to the key. 813 "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). 814 }, 815 ], 816 }, 817 ], 818 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 819 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 820 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 821 "name": "A String", # [Output Only] Name of the resource. 822 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 823 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 824 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 825 { 826 "message": "A String", # [Output Only] An optional, human-readable error message. 827 "code": "A String", # [Output Only] The error type identifier for this error. 828 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 829 }, 830 ], 831 }, 832 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 833 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 834 "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. 835 }</pre> 836 </div> 837 838 <div class="method"> 839 <code class="details" id="resize">resize(project, region, instanceGroupManager, size)</code> 840 <pre>Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. 841 842 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. 843 844 Args: 845 project: string, Project ID for this request. (required) 846 region: string, Name of the region scoping this request. (required) 847 instanceGroupManager: string, Name of the managed instance group. (required) 848 size: integer, Number of instances that should exist in this instance group manager. (required) 849 850 Returns: 851 An object of the form: 852 853 { # An Operation resource, used to manage asynchronous API requests. 854 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 855 "clientOperationId": "A String", # [Output Only] Reserved for future use. 856 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 857 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 858 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 859 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 860 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 861 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 862 "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. 863 "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. 864 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 865 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 866 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 867 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 868 { 869 "message": "A String", # [Output Only] A human-readable description of the warning code. 870 "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. 871 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 872 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 873 { 874 "value": "A String", # [Output Only] A warning data value corresponding to the key. 875 "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). 876 }, 877 ], 878 }, 879 ], 880 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 881 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 882 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 883 "name": "A String", # [Output Only] Name of the resource. 884 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 885 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 886 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 887 { 888 "message": "A String", # [Output Only] An optional, human-readable error message. 889 "code": "A String", # [Output Only] The error type identifier for this error. 890 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 891 }, 892 ], 893 }, 894 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 895 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 896 "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. 897 }</pre> 898 </div> 899 900 <div class="method"> 901 <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</code> 902 <pre>Modifies the autohealing policy for the instances in this managed instance group. 903 904 Args: 905 project: string, Project ID for this request. (required) 906 region: string, Name of the region scoping this request. (required) 907 instanceGroupManager: string, Name of the managed instance group. (required) 908 body: object, The request body. (required) 909 The object takes the form of: 910 911 { 912 "autoHealingPolicies": [ 913 { 914 "healthCheck": "A String", # The URL for the health check that signals autohealing. 915 "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]. 916 }, 917 ], 918 } 919 920 921 Returns: 922 An object of the form: 923 924 { # An Operation resource, used to manage asynchronous API requests. 925 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 926 "clientOperationId": "A String", # [Output Only] Reserved for future use. 927 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 928 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 929 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 930 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 931 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 932 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 933 "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. 934 "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. 935 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 936 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 937 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 938 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 939 { 940 "message": "A String", # [Output Only] A human-readable description of the warning code. 941 "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. 942 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 943 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 944 { 945 "value": "A String", # [Output Only] A warning data value corresponding to the key. 946 "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). 947 }, 948 ], 949 }, 950 ], 951 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 952 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 953 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 954 "name": "A String", # [Output Only] Name of the resource. 955 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 956 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 957 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 958 { 959 "message": "A String", # [Output Only] An optional, human-readable error message. 960 "code": "A String", # [Output Only] The error type identifier for this error. 961 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 962 }, 963 ], 964 }, 965 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 966 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 967 "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. 968 }</pre> 969 </div> 970 971 <div class="method"> 972 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</code> 973 <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. 974 975 Args: 976 project: string, Project ID for this request. (required) 977 region: string, Name of the region scoping this request. (required) 978 instanceGroupManager: string, The name of the managed instance group. (required) 979 body: object, The request body. (required) 980 The object takes the form of: 981 982 { 983 "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created. 984 } 985 986 987 Returns: 988 An object of the form: 989 990 { # An Operation resource, used to manage asynchronous API requests. 991 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 992 "clientOperationId": "A String", # [Output Only] Reserved for future use. 993 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 994 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 995 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 996 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 997 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 998 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 999 "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. 1000 "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. 1001 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1002 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1003 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1004 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1005 { 1006 "message": "A String", # [Output Only] A human-readable description of the warning code. 1007 "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. 1008 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1009 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1010 { 1011 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1012 "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). 1013 }, 1014 ], 1015 }, 1016 ], 1017 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1018 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1019 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1020 "name": "A String", # [Output Only] Name of the resource. 1021 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1022 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1023 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1024 { 1025 "message": "A String", # [Output Only] An optional, human-readable error message. 1026 "code": "A String", # [Output Only] The error type identifier for this error. 1027 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1028 }, 1029 ], 1030 }, 1031 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1032 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1033 "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. 1034 }</pre> 1035 </div> 1036 1037 <div class="method"> 1038 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</code> 1039 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. 1040 1041 Args: 1042 project: string, Project ID for this request. (required) 1043 region: string, Name of the region scoping this request. (required) 1044 instanceGroupManager: string, Name of the managed instance group. (required) 1045 body: object, The request body. (required) 1046 The object takes the form of: 1047 1048 { 1049 "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. 1050 "A String", 1051 ], 1052 "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. 1053 } 1054 1055 1056 Returns: 1057 An object of the form: 1058 1059 { # An Operation resource, used to manage asynchronous API requests. 1060 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1061 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1062 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1063 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1064 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1065 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1066 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1067 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1068 "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. 1069 "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. 1070 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1071 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1072 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1073 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1074 { 1075 "message": "A String", # [Output Only] A human-readable description of the warning code. 1076 "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. 1077 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1078 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1079 { 1080 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1081 "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). 1082 }, 1083 ], 1084 }, 1085 ], 1086 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1087 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1088 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1089 "name": "A String", # [Output Only] Name of the resource. 1090 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1091 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1092 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1093 { 1094 "message": "A String", # [Output Only] An optional, human-readable error message. 1095 "code": "A String", # [Output Only] The error type identifier for this error. 1096 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1097 }, 1098 ], 1099 }, 1100 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1101 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1102 "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. 1103 }</pre> 1104 </div> 1105 1106 <div class="method"> 1107 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 1108 <pre>Returns permissions that a caller has on the specified resource. 1109 1110 Args: 1111 project: string, Project ID for this request. (required) 1112 region: string, The name of the region for this request. (required) 1113 resource: string, Name of the resource for this request. (required) 1114 body: object, The request body. (required) 1115 The object takes the form of: 1116 1117 { 1118 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1119 "A String", 1120 ], 1121 } 1122 1123 1124 Returns: 1125 An object of the form: 1126 1127 { 1128 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1129 "A String", 1130 ], 1131 }</pre> 1132 </div> 1133 1134 <div class="method"> 1135 <code class="details" id="update">update(project, region, instanceGroupManager, body)</code> 1136 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. 1137 1138 Args: 1139 project: string, Project ID for this request. (required) 1140 region: string, Name of the region scoping this request. (required) 1141 instanceGroupManager: string, The name of the instance group manager. (required) 1142 body: object, The request body. (required) 1143 The object takes the form of: 1144 1145 { # An Instance Group Manager resource. 1146 "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. 1147 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. 1148 "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. 1149 "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. 1150 # 1151 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. 1152 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. 1153 "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. 1154 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. 1155 "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. 1156 "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. 1157 }, 1158 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1159 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). 1160 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value. 1161 { 1162 "healthCheck": "A String", # The URL for the health check that signals autohealing. 1163 "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]. 1164 }, 1165 ], 1166 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. 1167 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. 1168 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. 1169 "serviceAccount": "A String", # Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used. 1170 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. 1171 "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. 1172 "A String", 1173 ], 1174 "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. 1175 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. 1176 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). 1177 "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. 1178 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. 1179 { # The named port. For example: . 1180 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 1181 "port": 42, # The port number, which can be a value between 1 and 65535. 1182 }, 1183 ], 1184 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. 1185 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. 1186 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. 1187 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. 1188 } 1189 1190 1191 Returns: 1192 An object of the form: 1193 1194 { # An Operation resource, used to manage asynchronous API requests. 1195 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1196 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1197 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1199 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1200 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1201 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1202 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1203 "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. 1204 "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. 1205 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1206 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1207 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1208 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1209 { 1210 "message": "A String", # [Output Only] A human-readable description of the warning code. 1211 "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. 1212 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1213 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1214 { 1215 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1216 "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). 1217 }, 1218 ], 1219 }, 1220 ], 1221 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1222 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1223 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1224 "name": "A String", # [Output Only] Name of the resource. 1225 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1226 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1227 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1228 { 1229 "message": "A String", # [Output Only] An optional, human-readable error message. 1230 "code": "A String", # [Output Only] The error type identifier for this error. 1231 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1232 }, 1233 ], 1234 }, 1235 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1236 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1237 "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. 1238 }</pre> 1239 </div> 1240 1241 </body></html>
