Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / dyn / compute_v1beta13.instances.html
blob: 69782a250a79dac6c9b1f45001b36c8cf290889b [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[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_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addAccessConfig">addAccessConfig(project, instance, network_interface, body)</a></code></p>
79<p class="firstline">Adds an access config to an instance's network interface.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, instance)</a></code></p>
82<p class="firstline">Deletes the specified instance resource.</p>
83<p class="toc_element">
84 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, instance, access_config, network_interface)</a></code></p>
85<p class="firstline">Deletes an access config from an instance's network interface.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, instance)</a></code></p>
88<p class="firstline">Returns the specified instance resource.</p>
89<p class="toc_element">
90 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, instance)</a></code></p>
91<p class="firstline">Returns the specified instance's serial port output.</p>
92<p class="toc_element">
93 <code><a href="#insert">insert(project, body)</a></code></p>
94<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
95<p class="toc_element">
96 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
97<p class="firstline">Retrieves the list of instance resources contained within the specified project.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="addAccessConfig">addAccessConfig(project, instance, network_interface, body)</code>
104 <pre>Adds an access config to an instance's network interface.
105
106Args:
107 project: string, Project name. (required)
108 instance: string, Instance name. (required)
109 network_interface: string, Network interface name. (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
113{
114 "kind": "compute#accessConfig", # Type of the resource.
115 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
116 "name": "A String", # Name of this access configuration.
117 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
118}
119
120
121Returns:
122 An object of the form:
123
124 {
125 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
126 "kind": "compute#operation", # Type of the resource.
127 "name": "A String", # Name of the resource.
128 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
129 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
130 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
131 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
132 "errors": [ # The array of errors encountered while processing this operation.
133 {
134 "message": "A String", # An optional, human-readable error message.
135 "code": "A String", # The error type identifier for this error.
136 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
137 },
138 ],
139 },
140 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
141 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
142 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
143 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
144 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
145 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
146 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
147 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
148 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
149 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
150 "selfLink": "A String", # Server defined URL for the resource (output only).
151 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="delete">delete(project, instance)</code>
157 <pre>Deletes the specified instance resource.
158
159Args:
160 project: string, Name of the project scoping this request. (required)
161 instance: string, Name of the instance resource to delete. (required)
162
163Returns:
164 An object of the form:
165
166 {
167 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
168 "kind": "compute#operation", # Type of the resource.
169 "name": "A String", # Name of the resource.
170 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
171 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
172 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
173 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
174 "errors": [ # The array of errors encountered while processing this operation.
175 {
176 "message": "A String", # An optional, human-readable error message.
177 "code": "A String", # The error type identifier for this error.
178 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
179 },
180 ],
181 },
182 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
183 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
184 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
185 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
186 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
187 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
188 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
189 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
190 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
191 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
192 "selfLink": "A String", # Server defined URL for the resource (output only).
193 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
194 }</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, instance, access_config, network_interface)</code>
199 <pre>Deletes an access config from an instance's network interface.
200
201Args:
202 project: string, Project name. (required)
203 instance: string, Instance name. (required)
204 access_config: string, Access config name. (required)
205 network_interface: string, Network interface name. (required)
206
207Returns:
208 An object of the form:
209
210 {
211 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
212 "kind": "compute#operation", # Type of the resource.
213 "name": "A String", # Name of the resource.
214 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
215 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
216 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
217 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
218 "errors": [ # The array of errors encountered while processing this operation.
219 {
220 "message": "A String", # An optional, human-readable error message.
221 "code": "A String", # The error type identifier for this error.
222 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
223 },
224 ],
225 },
226 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
227 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
228 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
229 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
230 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
231 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
232 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
233 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
234 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
235 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
236 "selfLink": "A String", # Server defined URL for the resource (output only).
237 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="get">get(project, instance)</code>
243 <pre>Returns the specified instance resource.
244
245Args:
246 project: string, Name of the project scoping this request. (required)
247 instance: string, Name of the instance resource to return. (required)
248
249Returns:
250 An object of the form:
251
252 {
253 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
254 "kind": "compute#instance", # Type of the resource.
255 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
256 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
257 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
258 "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
259 "A String",
260 ],
261 "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
262 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
263 {
264 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
265 "kind": "compute#attachedDisk", # Type of the resource.
266 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
267 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
268 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
269 "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
270 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
271 },
272 ],
273 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
274 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
275 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
276 {
277 "scopes": [ # The list of scopes to be made available for this service account.
278 "A String",
279 ],
280 "kind": "compute#serviceAccount", # Type of the resource.
281 "email": "A String", # Email address of the service account.
282 },
283 ],
284 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
285 {
286 "network": "A String", # URL of the network resource attached to this interface.
287 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
288 {
289 "kind": "compute#accessConfig", # Type of the resource.
290 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
291 "name": "A String", # Name of this access configuration.
292 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
293 },
294 ],
295 "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
296 "kind": "compute#networkInterface", # Type of the resource.
297 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
298 },
299 ],
300 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
301 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
302 "selfLink": "A String", # Server defined URL for the resource (output only).
303 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
304 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
305 {
306 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
307 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
308 },
309 ],
310 "kind": "compute#metadata", # Type of the resource.
311 },
312 }</pre>
313</div>
314
315<div class="method">
316 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, instance)</code>
317 <pre>Returns the specified instance's serial port output.
318
319Args:
320 project: string, Name of the project scoping this request. (required)
321 instance: string, Name of the instance scoping this request. (required)
322
323Returns:
324 An object of the form:
325
326 { # An instance serial console output.
327 "kind": "compute#serialPortOutput", # Type of the resource.
328 "selfLink": "A String", # Server defined URL for the resource.
329 "contents": "A String", # The contents of the console output.
330 }</pre>
331</div>
332
333<div class="method">
334 <code class="details" id="insert">insert(project, body)</code>
335 <pre>Creates an instance resource in the specified project using the data included in the request.
336
337Args:
338 project: string, Name of the project scoping this request. (required)
339 body: object, The request body. (required)
340 The object takes the form of:
341
342{
343 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
344 "kind": "compute#instance", # Type of the resource.
345 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
346 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
347 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
348 "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
349 "A String",
350 ],
351 "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
352 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
353 {
354 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
355 "kind": "compute#attachedDisk", # Type of the resource.
356 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
357 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
358 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
359 "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
360 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
361 },
362 ],
363 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
364 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
365 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
366 {
367 "scopes": [ # The list of scopes to be made available for this service account.
368 "A String",
369 ],
370 "kind": "compute#serviceAccount", # Type of the resource.
371 "email": "A String", # Email address of the service account.
372 },
373 ],
374 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
375 {
376 "network": "A String", # URL of the network resource attached to this interface.
377 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
378 {
379 "kind": "compute#accessConfig", # Type of the resource.
380 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
381 "name": "A String", # Name of this access configuration.
382 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
383 },
384 ],
385 "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
386 "kind": "compute#networkInterface", # Type of the resource.
387 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
388 },
389 ],
390 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
391 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
392 "selfLink": "A String", # Server defined URL for the resource (output only).
393 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
394 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
395 {
396 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
397 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
398 },
399 ],
400 "kind": "compute#metadata", # Type of the resource.
401 },
402}
403
404
405Returns:
406 An object of the form:
407
408 {
409 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
410 "kind": "compute#operation", # Type of the resource.
411 "name": "A String", # Name of the resource.
412 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
413 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
414 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
415 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
416 "errors": [ # The array of errors encountered while processing this operation.
417 {
418 "message": "A String", # An optional, human-readable error message.
419 "code": "A String", # The error type identifier for this error.
420 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
421 },
422 ],
423 },
424 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
425 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
426 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
427 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
428 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
429 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
430 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
431 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
432 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
433 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
434 "selfLink": "A String", # Server defined URL for the resource (output only).
435 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
436 }</pre>
437</div>
438
439<div class="method">
440 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
441 <pre>Retrieves the list of instance resources contained within the specified project.
442
443Args:
444 project: string, Name of the project scoping this request. (required)
445 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
446 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
447 filter: string, Optional. Filter expression for filtering listed resources.
448
449Returns:
450 An object of the form:
451
452 {
453 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
454 "items": [ # A list of instance resources.
455 {
456 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
457 "kind": "compute#instance", # Type of the resource.
458 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
459 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
460 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
461 "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
462 "A String",
463 ],
464 "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
465 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
466 {
467 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
468 "kind": "compute#attachedDisk", # Type of the resource.
469 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
470 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
471 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
472 "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
473 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
474 },
475 ],
476 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
477 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
478 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
479 {
480 "scopes": [ # The list of scopes to be made available for this service account.
481 "A String",
482 ],
483 "kind": "compute#serviceAccount", # Type of the resource.
484 "email": "A String", # Email address of the service account.
485 },
486 ],
487 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
488 {
489 "network": "A String", # URL of the network resource attached to this interface.
490 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
491 {
492 "kind": "compute#accessConfig", # Type of the resource.
493 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
494 "name": "A String", # Name of this access configuration.
495 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
496 },
497 ],
498 "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
499 "kind": "compute#networkInterface", # Type of the resource.
500 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
501 },
502 ],
503 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
504 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
505 "selfLink": "A String", # Server defined URL for the resource (output only).
506 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
507 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
508 {
509 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
510 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
511 },
512 ],
513 "kind": "compute#metadata", # Type of the resource.
514 },
515 },
516 ],
517 "kind": "compute#instanceList", # Type of resource.
518 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
519 "selfLink": "A String", # Server defined URL for this resource (output only).
520 }</pre>
521</div>
522
523<div class="method">
524 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
525 <pre>Retrieves the next page of results.
526
527Args:
528 previous_request: The request for the previous page. (required)
529 previous_response: The response from the request for the previous page. (required)
530
531Returns:
532 A request object that you can call 'execute()' on to request the next
533 page. Returns None if there are no more items in the collection.
534 </pre>
535</div>
536
537</body></html>