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