Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1024403cf988cb1c83348c05f0f6ff205dd5159c / . / docs / dyn / compute_v1beta12.instances.html
blob: d6ecd92435d8a2105839216e71bcd17953c69a26 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[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_v1beta12.html">Compute Engine API</a> . <a href="compute_v1beta12.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="#insert">insert(project, body)</a></code></p>
91<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of instance resources contained within the specified project.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="addAccessConfig">addAccessConfig(project, instance, network_interface, body)</code>
101 <pre>Adds an access config to an instance's network interface.
102
103Args:
104 project: string, Project name. (required)
105 instance: string, Instance name. (required)
106 network_interface: string, Network interface name. (required)
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{
111 "kind": "compute#accessConfig", # Type of the resource.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]112 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]113 "name": "A String", # Name of this access configuration.
114 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
115}
116
117
118Returns:
119 An object of the form:
120
121 {
122 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
123 "kind": "compute#operation", # Type of the resource.
124 "name": "A String", # Name of the resource.
125 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
126 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
127 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
128 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
129 "errors": [ # The array of errors encountered while processing this operation.
130 {
131 "message": "A String", # An optional, human-readable error message.
132 "code": "A String", # The error type identifier for this error.
133 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
134 },
135 ],
136 },
137 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
138 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
139 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
140 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
141 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
142 "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).
143 "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).
144 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
145 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
146 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
147 "selfLink": "A String", # Server defined URL for the resource (output only).
148 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="delete">delete(project, instance)</code>
154 <pre>Deletes the specified instance resource.
155
156Args:
157 project: string, Name of the project scoping this request. (required)
158 instance: string, Name of the instance resource to delete. (required)
159
160Returns:
161 An object of the form:
162
163 {
164 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
165 "kind": "compute#operation", # Type of the resource.
166 "name": "A String", # Name of the resource.
167 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
168 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
169 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
170 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
171 "errors": [ # The array of errors encountered while processing this operation.
172 {
173 "message": "A String", # An optional, human-readable error message.
174 "code": "A String", # The error type identifier for this error.
175 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
176 },
177 ],
178 },
179 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
180 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
181 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
182 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
183 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
184 "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).
185 "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).
186 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
187 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
188 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
189 "selfLink": "A String", # Server defined URL for the resource (output only).
190 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, instance, access_config, network_interface)</code>
196 <pre>Deletes an access config from an instance's network interface.
197
198Args:
199 project: string, Project name. (required)
200 instance: string, Instance name. (required)
201 access_config: string, Access config name. (required)
202 network_interface: string, Network interface name. (required)
203
204Returns:
205 An object of the form:
206
207 {
208 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
209 "kind": "compute#operation", # Type of the resource.
210 "name": "A String", # Name of the resource.
211 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
212 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
213 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
214 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
215 "errors": [ # The array of errors encountered while processing this operation.
216 {
217 "message": "A String", # An optional, human-readable error message.
218 "code": "A String", # The error type identifier for this error.
219 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
220 },
221 ],
222 },
223 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
224 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
225 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
226 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
227 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
228 "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).
229 "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).
230 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
231 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
232 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
233 "selfLink": "A String", # Server defined URL for the resource (output only).
234 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
235 }</pre>
236</div>
237
238<div class="method">
239 <code class="details" id="get">get(project, instance)</code>
240 <pre>Returns the specified instance resource.
241
242Args:
243 project: string, Name of the project scoping this request. (required)
244 instance: string, Name of the instance resource to return. (required)
245
246Returns:
247 An object of the form:
248
249 {
250 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
251 "kind": "compute#instance", # Type of the resource.
252 "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.
253 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
254 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
255 "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.
256 "A String",
257 ],
258 "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.
259 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
260 {
261 "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.
262 "kind": "compute#attachedDisk", # Type of the resource.
263 "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.
264 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
265 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
266 "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.
267 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
268 },
269 ],
270 "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.
271 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
272 "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.
273 {
274 "scopes": [ # The list of scopes to be made available for this service account.
275 "A String",
276 ],
277 "kind": "compute#serviceAccount", # Type of the resource.
278 "email": "A String", # Email address of the service account.
279 },
280 ],
281 "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.
282 {
283 "network": "A String", # URL of the network resource attached to this interface.
284 "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.
285 {
286 "kind": "compute#accessConfig", # Type of the resource.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]287 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]288 "name": "A String", # Name of this access configuration.
289 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
290 },
291 ],
292 "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.
293 "kind": "compute#networkInterface", # Type of the resource.
294 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
295 },
296 ],
297 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
298 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
299 "selfLink": "A String", # Server defined URL for the resource (output only).
300 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
301 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
302 {
303 "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 15000 bytes.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]304 "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 be unique.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]305 },
306 ],
307 "kind": "compute#metadata", # Type of the resource.
308 },
309 }</pre>
310</div>
311
312<div class="method">
313 <code class="details" id="insert">insert(project, body)</code>
314 <pre>Creates an instance resource in the specified project using the data included in the request.
315
316Args:
317 project: string, Name of the project scoping this request. (required)
318 body: object, The request body. (required)
319 The object takes the form of:
320
321{
322 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
323 "kind": "compute#instance", # Type of the resource.
324 "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.
325 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
326 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
327 "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.
328 "A String",
329 ],
330 "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.
331 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
332 {
333 "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.
334 "kind": "compute#attachedDisk", # Type of the resource.
335 "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.
336 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
337 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
338 "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.
339 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
340 },
341 ],
342 "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.
343 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
344 "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.
345 {
346 "scopes": [ # The list of scopes to be made available for this service account.
347 "A String",
348 ],
349 "kind": "compute#serviceAccount", # Type of the resource.
350 "email": "A String", # Email address of the service account.
351 },
352 ],
353 "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.
354 {
355 "network": "A String", # URL of the network resource attached to this interface.
356 "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.
357 {
358 "kind": "compute#accessConfig", # Type of the resource.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]359 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]360 "name": "A String", # Name of this access configuration.
361 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
362 },
363 ],
364 "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.
365 "kind": "compute#networkInterface", # Type of the resource.
366 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
367 },
368 ],
369 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
370 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
371 "selfLink": "A String", # Server defined URL for the resource (output only).
372 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
373 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
374 {
375 "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 15000 bytes.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]376 "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 be unique.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]377 },
378 ],
379 "kind": "compute#metadata", # Type of the resource.
380 },
381 }
382
383
384Returns:
385 An object of the form:
386
387 {
388 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
389 "kind": "compute#operation", # Type of the resource.
390 "name": "A String", # Name of the resource.
391 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
392 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
393 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
394 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
395 "errors": [ # The array of errors encountered while processing this operation.
396 {
397 "message": "A String", # An optional, human-readable error message.
398 "code": "A String", # The error type identifier for this error.
399 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
400 },
401 ],
402 },
403 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
404 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
405 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
406 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
407 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
408 "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).
409 "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).
410 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
411 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
412 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
413 "selfLink": "A String", # Server defined URL for the resource (output only).
414 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
415 }</pre>
416</div>
417
418<div class="method">
419 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
420 <pre>Retrieves the list of instance resources contained within the specified project.
421
422Args:
423 project: string, Name of the project scoping this request. (required)
424 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
425 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
426 filter: string, Optional. Filter expression for filtering listed resources.
427
428Returns:
429 An object of the form:
430
431 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]432 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]433 "items": [ # A list of instance resources.
434 {
435 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
436 "kind": "compute#instance", # Type of the resource.
437 "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.
438 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
439 "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
440 "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.
441 "A String",
442 ],
443 "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.
444 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
445 {
446 "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.
447 "kind": "compute#attachedDisk", # Type of the resource.
448 "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.
449 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
450 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
451 "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.
452 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
453 },
454 ],
455 "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.
456 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
457 "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.
458 {
459 "scopes": [ # The list of scopes to be made available for this service account.
460 "A String",
461 ],
462 "kind": "compute#serviceAccount", # Type of the resource.
463 "email": "A String", # Email address of the service account.
464 },
465 ],
466 "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.
467 {
468 "network": "A String", # URL of the network resource attached to this interface.
469 "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.
470 {
471 "kind": "compute#accessConfig", # Type of the resource.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]472 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]473 "name": "A String", # Name of this access configuration.
474 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
475 },
476 ],
477 "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.
478 "kind": "compute#networkInterface", # Type of the resource.
479 "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
480 },
481 ],
482 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
483 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
484 "selfLink": "A String", # Server defined URL for the resource (output only).
485 "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
486 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
487 {
488 "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 15000 bytes.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]489 "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 be unique.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]490 },
491 ],
492 "kind": "compute#metadata", # Type of the resource.
493 },
494 },
495 ],
496 "kind": "compute#instanceList", # Type of resource.
497 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
498 "selfLink": "A String", # Server defined URL for this resource (output only).
499 }</pre>
500</div>
501
502<div class="method">
503 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
504 <pre>Retrieves the next page of results.
505
506Args:
507 previous_request: The request for the previous page. (required)
508 previous_response: The response from the request for the previous page. (required)
509
510Returns:
511 A request object that you can call 'execute()' on to request the next
512 page. Returns None if there are no more items in the collection.
513 </pre>
514</div>
515
516</body></html>