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_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceGroups.html">instanceGroups</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body)</a></code></p> 79 <p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p> 80 <p class="toc_element"> 81 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 82 <p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p> 83 <p class="toc_element"> 84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 85 <p class="firstline">Retrieves the next page of results.</p> 86 <p class="toc_element"> 87 <code><a href="#delete">delete(project, zone, instanceGroup)</a></code></p> 88 <p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p> 89 <p class="toc_element"> 90 <code><a href="#get">get(project, zone, instanceGroup)</a></code></p> 91 <p class="firstline">Returns the specified instance group. Get a list of available instance groups by making a list() request.</p> 92 <p class="toc_element"> 93 <code><a href="#insert">insert(project, zone, body)</a></code></p> 94 <p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p> 95 <p class="toc_element"> 96 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97 <p class="firstline">Retrieves the list of instance groups that are located in the specified project and zone.</p> 98 <p class="toc_element"> 99 <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 100 <p class="firstline">Lists the instances in the specified instance group.</p> 101 <p class="toc_element"> 102 <code><a href="#listInstances_next">listInstances_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="#list_next">list_next(previous_request, previous_response)</a></code></p> 106 <p class="firstline">Retrieves the next page of results.</p> 107 <p class="toc_element"> 108 <code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body)</a></code></p> 109 <p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p> 110 <p class="toc_element"> 111 <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</a></code></p> 112 <p class="firstline">Sets the named ports for the specified instance group.</p> 113 <h3>Method Details</h3> 114 <div class="method"> 115 <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body)</code> 116 <pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. 117 118 Args: 119 project: string, Project ID for this request. (required) 120 zone: string, The name of the zone where the instance group is located. (required) 121 instanceGroup: string, The name of the instance group where you are adding instances. (required) 122 body: object, The request body. (required) 123 The object takes the form of: 124 125 { 126 "instances": [ # The list of instances to add to the instance group. 127 { 128 "instance": "A String", # The URL for a specific instance. 129 }, 130 ], 131 } 132 133 134 Returns: 135 An object of the form: 136 137 { # An Operation resource, used to manage asynchronous API requests. 138 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 139 "clientOperationId": "A String", # [Output Only] Reserved for future use. 140 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 141 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 142 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 143 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 144 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 145 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 146 "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. 147 "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. 148 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 149 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 150 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 151 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 152 { 153 "message": "A String", # [Output Only] A human-readable description of the warning code. 154 "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. 155 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 156 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 157 { 158 "value": "A String", # [Output Only] A warning data value corresponding to the key. 159 "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). 160 }, 161 ], 162 }, 163 ], 164 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 165 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 166 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 167 "name": "A String", # [Output Only] Name of the resource. 168 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 169 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 170 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 171 { 172 "message": "A String", # [Output Only] An optional, human-readable error message. 173 "code": "A String", # [Output Only] The error type identifier for this error. 174 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 175 }, 176 ], 177 }, 178 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 179 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 180 "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. 181 }</pre> 182 </div> 183 184 <div class="method"> 185 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 186 <pre>Retrieves the list of instance groups and sorts them by zone. 187 188 Args: 189 project: string, Project ID for this request. (required) 190 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 191 192 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. 193 194 Currently, only sorting by name or creationTimestamp desc is supported. 195 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) 196 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. 197 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. 198 199 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. 200 201 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 202 203 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. 204 205 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. 206 207 Returns: 208 An object of the form: 209 210 { 211 "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. 212 "items": { # A map of scoped instance group lists. 213 "a_key": { # The name of the scope that contains this set of instance groups. 214 "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty. 215 "message": "A String", # [Output Only] A human-readable description of the warning code. 216 "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. 217 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 218 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 219 { 220 "value": "A String", # [Output Only] A warning data value corresponding to the key. 221 "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). 222 }, 223 ], 224 }, 225 "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope. 226 { 227 "size": 42, # [Output Only] The total number of instances in the instance group. 228 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. 229 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 230 "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources). 231 "region": "A String", # The URL of the region where the instance group is located (for regional resources). 232 "network": "A String", # The URL of the network to which all instances in the instance group belong. 233 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. 234 "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. 235 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 236 # 237 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] 238 # 239 # Named ports apply to all instances in this instance group. 240 { # The named port. For example: . 241 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 242 "port": 42, # The port number, which can be a value between 1 and 65535. 243 }, 244 ], 245 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. 246 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. 247 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. 248 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. 249 }, 250 ], 251 }, 252 }, 253 "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. 254 "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier. 255 "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL. 256 }</pre> 257 </div> 258 259 <div class="method"> 260 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 261 <pre>Retrieves the next page of results. 262 263 Args: 264 previous_request: The request for the previous page. (required) 265 previous_response: The response from the request for the previous page. (required) 266 267 Returns: 268 A request object that you can call 'execute()' on to request the next 269 page. Returns None if there are no more items in the collection. 270 </pre> 271 </div> 272 273 <div class="method"> 274 <code class="details" id="delete">delete(project, zone, instanceGroup)</code> 275 <pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. 276 277 Args: 278 project: string, Project ID for this request. (required) 279 zone: string, The name of the zone where the instance group is located. (required) 280 instanceGroup: string, The name of the instance group to delete. (required) 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, zone, instanceGroup)</code> 334 <pre>Returns the specified instance group. Get a list of available instance groups by making a list() request. 335 336 Args: 337 project: string, Project ID for this request. (required) 338 zone: string, The name of the zone where the instance group is located. (required) 339 instanceGroup: string, The name of the instance group. (required) 340 341 Returns: 342 An object of the form: 343 344 { 345 "size": 42, # [Output Only] The total number of instances in the instance group. 346 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. 347 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 348 "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources). 349 "region": "A String", # The URL of the region where the instance group is located (for regional resources). 350 "network": "A String", # The URL of the network to which all instances in the instance group belong. 351 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. 352 "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. 353 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 354 # 355 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] 356 # 357 # Named ports apply to all instances in this instance group. 358 { # The named port. For example: . 359 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 360 "port": 42, # The port number, which can be a value between 1 and 65535. 361 }, 362 ], 363 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. 364 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. 365 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. 366 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. 367 }</pre> 368 </div> 369 370 <div class="method"> 371 <code class="details" id="insert">insert(project, zone, body)</code> 372 <pre>Creates an instance group in the specified project using the parameters that are included in the request. 373 374 Args: 375 project: string, Project ID for this request. (required) 376 zone: string, The name of the zone where you want to create the instance group. (required) 377 body: object, The request body. (required) 378 The object takes the form of: 379 380 { 381 "size": 42, # [Output Only] The total number of instances in the instance group. 382 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. 383 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 384 "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources). 385 "region": "A String", # The URL of the region where the instance group is located (for regional resources). 386 "network": "A String", # The URL of the network to which all instances in the instance group belong. 387 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. 388 "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. 389 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 390 # 391 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] 392 # 393 # Named ports apply to all instances in this instance group. 394 { # The named port. For example: . 395 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 396 "port": 42, # The port number, which can be a value between 1 and 65535. 397 }, 398 ], 399 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. 400 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. 401 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. 402 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. 403 } 404 405 406 Returns: 407 An object of the form: 408 409 { # An Operation resource, used to manage asynchronous API requests. 410 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 411 "clientOperationId": "A String", # [Output Only] Reserved for future use. 412 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 413 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 414 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 415 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 416 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 417 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 418 "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. 419 "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. 420 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 421 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 422 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 423 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 424 { 425 "message": "A String", # [Output Only] A human-readable description of the warning code. 426 "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. 427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 428 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 429 { 430 "value": "A String", # [Output Only] A warning data value corresponding to the key. 431 "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). 432 }, 433 ], 434 }, 435 ], 436 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 437 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 438 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 439 "name": "A String", # [Output Only] Name of the resource. 440 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 441 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 442 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 443 { 444 "message": "A String", # [Output Only] An optional, human-readable error message. 445 "code": "A String", # [Output Only] The error type identifier for this error. 446 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 447 }, 448 ], 449 }, 450 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 451 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 452 "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. 453 }</pre> 454 </div> 455 456 <div class="method"> 457 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 458 <pre>Retrieves the list of instance groups that are located in the specified project and zone. 459 460 Args: 461 project: string, Project ID for this request. (required) 462 zone: string, The name of the zone where the instance group is located. (required) 463 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 464 465 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. 466 467 Currently, only sorting by name or creationTimestamp desc is supported. 468 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) 469 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. 470 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. 471 472 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. 473 474 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 475 476 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. 477 478 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. 479 480 Returns: 481 An object of the form: 482 483 { # A list of InstanceGroup resources. 484 "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. 485 "items": [ # A list of instance groups. 486 { 487 "size": 42, # [Output Only] The total number of instances in the instance group. 488 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. 489 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 490 "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources). 491 "region": "A String", # The URL of the region where the instance group is located (for regional resources). 492 "network": "A String", # The URL of the network to which all instances in the instance group belong. 493 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. 494 "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. 495 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 496 # 497 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] 498 # 499 # Named ports apply to all instances in this instance group. 500 { # The named port. For example: . 501 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 502 "port": 42, # The port number, which can be a value between 1 and 65535. 503 }, 504 ], 505 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. 506 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. 507 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. 508 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. 509 }, 510 ], 511 "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. 512 "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier. 513 "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL. 514 }</pre> 515 </div> 516 517 <div class="method"> 518 <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 519 <pre>Lists the instances in the specified instance group. 520 521 Args: 522 project: string, Project ID for this request. (required) 523 zone: string, The name of the zone where the instance group is located. (required) 524 instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required) 525 body: object, The request body. (required) 526 The object takes the form of: 527 528 { 529 "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. 530 } 531 532 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 533 534 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. 535 536 Currently, only sorting by name or creationTimestamp desc is supported. 537 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) 538 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. 539 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. 540 541 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. 542 543 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 544 545 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. 546 547 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. 548 549 Returns: 550 An object of the form: 551 552 { 553 "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. 554 "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances. 555 { 556 "status": "A String", # [Output Only] The status of the instance. 557 "instance": "A String", # [Output Only] The URL of the instance. 558 "namedPorts": [ # [Output Only] The named ports that belong to this instance group. 559 { # The named port. For example: . 560 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 561 "port": 42, # The port number, which can be a value between 1 and 65535. 562 }, 563 ], 564 }, 565 ], 566 "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. 567 "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier. 568 "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL. 569 }</pre> 570 </div> 571 572 <div class="method"> 573 <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code> 574 <pre>Retrieves the next page of results. 575 576 Args: 577 previous_request: The request for the previous page. (required) 578 previous_response: The response from the request for the previous page. (required) 579 580 Returns: 581 A request object that you can call 'execute()' on to request the next 582 page. Returns None if there are no more items in the collection. 583 </pre> 584 </div> 585 586 <div class="method"> 587 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 588 <pre>Retrieves the next page of results. 589 590 Args: 591 previous_request: The request for the previous page. (required) 592 previous_response: The response from the request for the previous page. (required) 593 594 Returns: 595 A request object that you can call 'execute()' on to request the next 596 page. Returns None if there are no more items in the collection. 597 </pre> 598 </div> 599 600 <div class="method"> 601 <code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body)</code> 602 <pre>Removes one or more instances from the specified instance group, but does not delete those instances. 603 604 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 before the VM instance is removed or deleted. 605 606 Args: 607 project: string, Project ID for this request. (required) 608 zone: string, The name of the zone where the instance group is located. (required) 609 instanceGroup: string, The name of the instance group where the specified instances will be removed. (required) 610 body: object, The request body. (required) 611 The object takes the form of: 612 613 { 614 "instances": [ # The list of instances to remove from the instance group. 615 { 616 "instance": "A String", # The URL for a specific instance. 617 }, 618 ], 619 } 620 621 622 Returns: 623 An object of the form: 624 625 { # An Operation resource, used to manage asynchronous API requests. 626 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 627 "clientOperationId": "A String", # [Output Only] Reserved for future use. 628 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 629 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 630 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 631 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 632 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 633 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 634 "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. 635 "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. 636 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 637 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 638 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 639 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 640 { 641 "message": "A String", # [Output Only] A human-readable description of the warning code. 642 "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. 643 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 644 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 645 { 646 "value": "A String", # [Output Only] A warning data value corresponding to the key. 647 "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). 648 }, 649 ], 650 }, 651 ], 652 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 653 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 654 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 655 "name": "A String", # [Output Only] Name of the resource. 656 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 657 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 658 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 659 { 660 "message": "A String", # [Output Only] An optional, human-readable error message. 661 "code": "A String", # [Output Only] The error type identifier for this error. 662 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 663 }, 664 ], 665 }, 666 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 667 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 668 "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. 669 }</pre> 670 </div> 671 672 <div class="method"> 673 <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</code> 674 <pre>Sets the named ports for the specified instance group. 675 676 Args: 677 project: string, Project ID for this request. (required) 678 zone: string, The name of the zone where the instance group is located. (required) 679 instanceGroup: string, The name of the instance group where the named ports are updated. (required) 680 body: object, The request body. (required) 681 The object takes the form of: 682 683 { 684 "namedPorts": [ # The list of named ports to set for this instance group. 685 { # The named port. For example: . 686 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. 687 "port": 42, # The port number, which can be a value between 1 and 65535. 688 }, 689 ], 690 "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. 691 } 692 693 694 Returns: 695 An object of the form: 696 697 { # An Operation resource, used to manage asynchronous API requests. 698 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 699 "clientOperationId": "A String", # [Output Only] Reserved for future use. 700 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 701 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 702 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 703 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 704 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 705 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 706 "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. 707 "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. 708 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 709 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 710 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 711 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 712 { 713 "message": "A String", # [Output Only] A human-readable description of the warning code. 714 "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. 715 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 716 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 717 { 718 "value": "A String", # [Output Only] A warning data value corresponding to the key. 719 "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). 720 }, 721 ], 722 }, 723 ], 724 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 725 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 726 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 727 "name": "A String", # [Output Only] Name of the resource. 728 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 729 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 730 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 731 { 732 "message": "A String", # [Output Only] An optional, human-readable error message. 733 "code": "A String", # [Output Only] The error type identifier for this error. 734 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 735 }, 736 ], 737 }, 738 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 739 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 740 "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. 741 }</pre> 742 </div> 743 744 </body></html>
