1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroups.html">regionInstanceGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(project, region, instanceGroup)</a></code></p>
79<p class="firstline">Returns the specified instance group resource.</p>
80<p class="toc_element">
81  <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of instance group resources contained within the specified region.</p>
83<p class="toc_element">
84  <code><a href="#listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.</p>
86<p class="toc_element">
87  <code><a href="#listInstances_next">listInstances_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#setNamedPorts">setNamedPorts(project, region, instanceGroup, body, requestId=None)</a></code></p>
94<p class="firstline">Sets the named ports for the specified regional instance group.</p>
95<p class="toc_element">
96  <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="get">get(project, region, instanceGroup)</code>
101  <pre>Returns the specified instance group resource.
102
103Args:
104  project: string, Project ID for this request. (required)
105  region: string, Name of the region scoping this request. (required)
106  instanceGroup: string, Name of the instance group resource to return. (required)
107
108Returns:
109  An object of the form:
110
111    { # Represents an unmanaged Instance Group resource.
112        #
113        # Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read  Instance groups.
114        #
115        # For zonal unmanaged Instance Group, use instanceGroups resource.
116        #
117        # For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==)
118      "size": 42, # [Output Only] The total number of instances in the instance group.
119      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
120      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
121      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
122      "region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
123      "network": "A String", # The URL of the network to which all instances in the instance group belong.
124      "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.
125      "subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong.
126      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
127          #
128          # 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}]
129          #
130          # Named ports apply to all instances in this instance group.
131        { # The named port. For example: .
132          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
133          "port": 42, # The port number, which can be a value between 1 and 65535.
134        },
135      ],
136      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
137      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
138      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
139      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
140    }</pre>
141</div>
142
143<div class="method">
144    <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
145  <pre>Retrieves the list of instance group resources contained within the specified region.
146
147Args:
148  project: string, Project ID for this request. (required)
149  region: string, Name of the region scoping this request. (required)
150  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
151
152You 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.
153
154Currently, only sorting by name or creationTimestamp desc is supported.
155  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)
156  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.
157  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
158
159For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
160
161You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
162
163To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
164
165Returns:
166  An object of the form:
167
168    { # Contains a list of InstanceGroup resources.
169    "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.
170    "kind": "compute#regionInstanceGroupList", # The resource type.
171    "items": [ # A list of InstanceGroup resources.
172      { # Represents an unmanaged Instance Group resource.
173            #
174            # Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read  Instance groups.
175            #
176            # For zonal unmanaged Instance Group, use instanceGroups resource.
177            #
178            # For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==)
179          "size": 42, # [Output Only] The total number of instances in the instance group.
180          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
181          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
182          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
183          "region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
184          "network": "A String", # The URL of the network to which all instances in the instance group belong.
185          "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.
186          "subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong.
187          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
188              #
189              # 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}]
190              #
191              # Named ports apply to all instances in this instance group.
192            { # The named port. For example: .
193              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
194              "port": 42, # The port number, which can be a value between 1 and 65535.
195            },
196          ],
197          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
198          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
199          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
200          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
201        },
202    ],
203    "warning": { # [Output Only] Informational warning message.
204      "message": "A String", # [Output Only] A human-readable description of the warning code.
205      "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.
206      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
207          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
208        {
209          "value": "A String", # [Output Only] A warning data value corresponding to the key.
210          "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).
211        },
212      ],
213    },
214    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
215    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
216  }</pre>
217</div>
218
219<div class="method">
220    <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
221  <pre>Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.
222
223Args:
224  project: string, Project ID for this request. (required)
225  region: string, Name of the region scoping this request. (required)
226  instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
227  body: object, The request body. (required)
228    The object takes the form of:
229
230{
231    "portName": "A String", # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
232    "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
233  }
234
235  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
236
237You 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.
238
239Currently, only sorting by name or creationTimestamp desc is supported.
240  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)
241  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.
242  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
243
244For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
245
246You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
247
248To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
249
250Returns:
251  An object of the form:
252
253    {
254    "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.
255    "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
256    "items": [ # A list of InstanceWithNamedPorts resources.
257      {
258        "status": "A String", # [Output Only] The status of the instance.
259        "instance": "A String", # [Output Only] The URL of the instance.
260        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
261          { # The named port. For example: .
262            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
263            "port": 42, # The port number, which can be a value between 1 and 65535.
264          },
265        ],
266      },
267    ],
268    "warning": { # [Output Only] Informational warning message.
269      "message": "A String", # [Output Only] A human-readable description of the warning code.
270      "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.
271      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
272          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
273        {
274          "value": "A String", # [Output Only] A warning data value corresponding to the key.
275          "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).
276        },
277      ],
278    },
279    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
280    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
281  }</pre>
282</div>
283
284<div class="method">
285    <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
286  <pre>Retrieves the next page of results.
287
288Args:
289  previous_request: The request for the previous page. (required)
290  previous_response: The response from the request for the previous page. (required)
291
292Returns:
293  A request object that you can call 'execute()' on to request the next
294  page. Returns None if there are no more items in the collection.
295    </pre>
296</div>
297
298<div class="method">
299    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
300  <pre>Retrieves the next page of results.
301
302Args:
303  previous_request: The request for the previous page. (required)
304  previous_response: The response from the request for the previous page. (required)
305
306Returns:
307  A request object that you can call 'execute()' on to request the next
308  page. Returns None if there are no more items in the collection.
309    </pre>
310</div>
311
312<div class="method">
313    <code class="details" id="setNamedPorts">setNamedPorts(project, region, instanceGroup, body, requestId=None)</code>
314  <pre>Sets the named ports for the specified regional instance group.
315
316Args:
317  project: string, Project ID for this request. (required)
318  region: string, Name of the region scoping this request. (required)
319  instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
320  body: object, The request body. (required)
321    The object takes the form of:
322
323{
324    "namedPorts": [ # The list of named ports to set for this instance group.
325      { # The named port. For example: .
326        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
327        "port": 42, # The port number, which can be a value between 1 and 65535.
328      },
329    ],
330    "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.
331  }
332
333  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
334
335For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
336
337The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
338
339Returns:
340  An object of the form:
341
342    { # Represents an Operation resource.
343      #
344      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
345      #
346      # Operations can be global, regional or zonal.
347      # - For global operations, use the globalOperations resource.
348      # - For regional operations, use the regionOperations resource.
349      # - For zonal operations, use the zonalOperations resource.
350      #
351      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
352    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
353    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
354    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
355    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
356    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
357    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
358    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
359    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
360    "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.
361    "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.
362    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
363    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
364    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
365    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
366      {
367        "message": "A String", # [Output Only] A human-readable description of the warning code.
368        "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.
369        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
370            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
371          {
372            "value": "A String", # [Output Only] A warning data value corresponding to the key.
373            "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).
374          },
375        ],
376      },
377    ],
378    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
379    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
380    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
381    "name": "A String", # [Output Only] Name of the resource.
382    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
383    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
384      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
385        {
386          "message": "A String", # [Output Only] An optional, human-readable error message.
387          "code": "A String", # [Output Only] The error type identifier for this error.
388          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
389        },
390      ],
391    },
392    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
393    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
394    "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.
395  }</pre>
396</div>
397
398<div class="method">
399    <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
400  <pre>Returns permissions that a caller has on the specified resource.
401
402Args:
403  project: string, Project ID for this request. (required)
404  region: string, The name of the region for this request. (required)
405  resource: string, Name or id of the resource for this request. (required)
406  body: object, The request body. (required)
407    The object takes the form of:
408
409{
410    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
411      "A String",
412    ],
413  }
414
415
416Returns:
417  An object of the form:
418
419    {
420    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
421      "A String",
422    ],
423  }</pre>
424</div>
425
426</body></html>