Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / compute_v1.instances.html
blob: d162f52675107c6a17ba9fc653a69fd0f310f613 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, 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="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]82<p class="firstline">Retrieves aggregated list of instances.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87 <code><a href="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]88<p class="firstline">Attaches a Disk resource to an instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#delete">delete(project, zone, instance)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]91<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<p class="toc_element">
93 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
94<p class="firstline">Deletes an access config from an instance's network interface.</p>
95<p class="toc_element">
96 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName)</a></code></p>
97<p class="firstline">Detaches a disk from an instance.</p>
98<p class="toc_element">
99 <code><a href="#get">get(project, zone, instance)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]100<p class="firstline">Returns the specified Instance resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Returns the specified instance's serial port output.</p>
104<p class="toc_element">
105 <code><a href="#insert">insert(project, zone, body)</a></code></p>
106<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
107<p class="toc_element">
108 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]109<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110<p class="toc_element">
111 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
114 <code><a href="#reset">reset(project, zone, instance)</a></code></p>
115<p class="firstline">Performs a hard reset on the instance.</p>
116<p class="toc_element">
117 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]120 <code><a href="#setMachineType">setMachineType(project, zone, instance, body)</a></code></p>
121<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
122<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 <code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
124<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
125<p class="toc_element">
126 <code><a href="#setScheduling">setScheduling(project, zone, instance, body)</a></code></p>
127<p class="firstline">Sets an instance's scheduling options.</p>
128<p class="toc_element">
129 <code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
130<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]131<p class="toc_element">
132 <code><a href="#start">start(project, zone, instance)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]133<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]134<p class="toc_element">
135 <code><a href="#stop">stop(project, zone, instance)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]136<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137<h3>Method Details</h3>
138<div class="method">
139 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
140 <pre>Adds an access config to an instance's network interface.
141
142Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 project: string, Project ID for this request. (required)
144 zone: string, The name of the zone for this request. (required)
145 instance: string, The instance name for this request. (required)
146 networkInterface: string, The name of the network interface to add to this instance. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147 body: object, The request body. (required)
148 The object takes the form of:
149
150{ # An access configuration attached to an instance's network interface.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
152 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 "name": "A String", # Name of this access configuration.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155}
156
157
158Returns:
159 An object of the form:
160
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]162 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
163 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]165 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
166 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
167 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
168 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]169 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]170 "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.
171 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]172 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]173 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
174 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]175 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]177 "message": "A String", # [Output Only] A human-readable description of the warning code.
178 "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.
179 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
180 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]183 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]184 },
185 ],
186 },
187 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]188 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]189 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
190 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]191 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]192 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]193 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]196 "message": "A String", # [Output Only] An optional, human-readable error message.
197 "code": "A String", # [Output Only] The error type identifier for this error.
198 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 },
200 ],
201 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]202 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]204 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 }</pre>
206</div>
207
208<div class="method">
209 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]210 <pre>Retrieves aggregated list of instances.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211
212Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]214 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.
215 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.
216 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]217
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]218The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]219
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]220For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
221
222Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
223
224The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225
226Returns:
227 An object of the form:
228
229 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]230 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]231 "items": { # [Output Only] A map of scoped instance lists.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]232 "a_key": { # [Output Only] Name of the scope containing this set of instances.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]233 "instances": [ # [Output Only] List of instances contained in this scope.
234 { # An Instance resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]235 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
236 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]237 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
238 "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]239 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]240 "zone": "A String", # [Output Only] URL of the zone where the instance resides.
241 "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]242 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
243 "A String",
244 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]245 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
246 #
247 # To see the latest fingerprint, make get() request to the instance.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]248 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
250 { # An instance-attached disk resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]252 #
253 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
254 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
255 "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
256 #
257 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
258 #
259 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
260 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
261 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
262 "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
263 #
264 # global/images/my-private-image
265 #
266 # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
267 #
268 # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
269 #
270 # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
271 "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
272 #
273 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
274 #
275 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
276 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
277 # - projects/project/zones/zone/diskTypes/diskType
278 # - zones/zone/diskTypes/diskType
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]279 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]280 "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
281 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
282 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
283 "licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]284 "A String",
285 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]286 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]287 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]288 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
289 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]290 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]292 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]293 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
294 "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]295 "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
296 "preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]297 "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]299 "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]300 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]301 # zones/us-central1-f/machineTypes/n1-standard-1
302 #
303 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
304 #
305 # zones/zone/machineTypes/custom-CPUS-MEMORY
306 #
307 # For example: zones/us-central1-f/machineTypes/custom-4-5120
308 #
309 # For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]310 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311 { # A service account.
312 "scopes": [ # The list of scopes to be made available for this service account.
313 "A String",
314 ],
315 "email": "A String", # Email address of the service account.
316 },
317 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]318 "networkInterfaces": [ # An 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]319 { # A network interface resource attached to an instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]320 "accessConfigs": [ # An array of configurations for this interface. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321 { # An access configuration attached to an instance's network interface.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]322 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
323 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 "name": "A String", # Name of this access configuration.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]325 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 },
327 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]328 "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
329 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]330 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
331 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
332 # - zones/zone/subnetworks/subnetwork
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]333 "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
334 #
335 # global/networks/default
336 #
337 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
338 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
339 # - projects/project/global/networks/network
340 # - global/networks/default
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]341 },
342 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]343 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]344 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
345 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]346 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
348 {
349 "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.
350 "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.
351 },
352 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]353 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
354 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]355 },
356 },
357 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]358 "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]359 "message": "A String", # [Output Only] A human-readable description of the warning code.
360 "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.
361 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
362 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]363 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]364 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]365 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]366 },
367 ],
368 },
369 },
370 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]371 "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]372 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
373 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]374 }</pre>
375</div>
376
377<div class="method">
378 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
379 <pre>Retrieves the next page of results.
380
381Args:
382 previous_request: The request for the previous page. (required)
383 previous_response: The response from the request for the previous page. (required)
384
385Returns:
386 A request object that you can call 'execute()' on to request the next
387 page. Returns None if there are no more items in the collection.
388 </pre>
389</div>
390
391<div class="method">
392 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]393 <pre>Attaches a Disk resource to an instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394
395Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]396 project: string, Project ID for this request. (required)
397 zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]398 instance: string, The instance name for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 body: object, The request body. (required)
400 The object takes the form of:
401
402{ # An instance-attached disk resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]403 "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]404 #
405 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
406 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
407 "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
408 #
409 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
410 #
411 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
412 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
413 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
414 "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
415 #
416 # global/images/my-private-image
417 #
418 # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
419 #
420 # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
421 #
422 # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
423 "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
424 #
425 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
426 #
427 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
428 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
429 # - projects/project/zones/zone/diskTypes/diskType
430 # - zones/zone/diskTypes/diskType
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]431 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]432 "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
433 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
434 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
435 "licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]436 "A String",
437 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]438 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]439 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]440 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
441 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]442}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]443
444
445Returns:
446 An object of the form:
447
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]448 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]449 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
450 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]451 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]452 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
453 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
454 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
455 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]456 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]457 "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.
458 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]459 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]460 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
461 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]462 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]463 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]464 "message": "A String", # [Output Only] A human-readable description of the warning code.
465 "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.
466 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
467 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]468 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]469 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]470 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]471 },
472 ],
473 },
474 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]475 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]476 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
477 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]478 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]479 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]480 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]481 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]482 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]483 "message": "A String", # [Output Only] An optional, human-readable error message.
484 "code": "A String", # [Output Only] The error type identifier for this error.
485 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]486 },
487 ],
488 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]489 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]490 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]491 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 }</pre>
493</div>
494
495<div class="method">
496 <code class="details" id="delete">delete(project, zone, instance)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]497 <pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]498
499Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]500 project: string, Project ID for this request. (required)
501 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]502 instance: string, Name of the instance resource to delete. (required)
503
504Returns:
505 An object of the form:
506
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]507 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]508 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
509 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]510 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]511 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
512 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
513 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
514 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]515 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]516 "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.
517 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]518 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]519 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
520 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]521 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]522 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]523 "message": "A String", # [Output Only] A human-readable description of the warning code.
524 "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.
525 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
526 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]527 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]528 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]529 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]530 },
531 ],
532 },
533 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]534 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]535 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
536 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]537 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]538 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]539 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]540 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]541 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]542 "message": "A String", # [Output Only] An optional, human-readable error message.
543 "code": "A String", # [Output Only] The error type identifier for this error.
544 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]545 },
546 ],
547 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]548 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]549 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]550 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]551 }</pre>
552</div>
553
554<div class="method">
555 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
556 <pre>Deletes an access config from an instance's network interface.
557
558Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]559 project: string, Project ID for this request. (required)
560 zone: string, The name of the zone for this request. (required)
561 instance: string, The instance name for this request. (required)
562 accessConfig: string, The name of the access config to delete. (required)
563 networkInterface: string, The name of the network interface. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]564
565Returns:
566 An object of the form:
567
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]568 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]569 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
570 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]571 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]572 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
573 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
574 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
575 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]576 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]577 "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.
578 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]579 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]580 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
581 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]582 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]583 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]584 "message": "A String", # [Output Only] A human-readable description of the warning code.
585 "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.
586 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
587 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]588 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]589 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]590 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]591 },
592 ],
593 },
594 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]595 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]596 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
597 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]598 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]599 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]600 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]601 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]602 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]603 "message": "A String", # [Output Only] An optional, human-readable error message.
604 "code": "A String", # [Output Only] The error type identifier for this error.
605 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]606 },
607 ],
608 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]609 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]610 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]611 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]612 }</pre>
613</div>
614
615<div class="method">
616 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
617 <pre>Detaches a disk from an instance.
618
619Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]620 project: string, Project ID for this request. (required)
621 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]622 instance: string, Instance name. (required)
623 deviceName: string, Disk device name to detach. (required)
624
625Returns:
626 An object of the form:
627
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]628 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]629 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
630 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]631 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]632 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
633 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
634 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
635 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]636 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]637 "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.
638 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]639 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]640 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
641 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]642 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]643 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]644 "message": "A String", # [Output Only] A human-readable description of the warning code.
645 "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.
646 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
647 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]648 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]649 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]650 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]651 },
652 ],
653 },
654 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]655 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]656 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
657 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]658 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]659 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]660 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]661 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]662 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]663 "message": "A String", # [Output Only] An optional, human-readable error message.
664 "code": "A String", # [Output Only] The error type identifier for this error.
665 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]666 },
667 ],
668 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]669 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]670 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]671 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]672 }</pre>
673</div>
674
675<div class="method">
676 <code class="details" id="get">get(project, zone, instance)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]677 <pre>Returns the specified Instance resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]678
679Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]680 project: string, Project ID for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]681 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]682 instance: string, Name of the instance resource to return. (required)
683
684Returns:
685 An object of the form:
686
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]687 { # An Instance resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]688 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
689 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]690 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
691 "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]692 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]693 "zone": "A String", # [Output Only] URL of the zone where the instance resides.
694 "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]695 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
696 "A String",
697 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]698 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
699 #
700 # To see the latest fingerprint, make get() request to the instance.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]701 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]702 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
703 { # An instance-attached disk resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]704 "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]705 #
706 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
707 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
708 "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
709 #
710 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
711 #
712 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
713 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
714 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
715 "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
716 #
717 # global/images/my-private-image
718 #
719 # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
720 #
721 # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
722 #
723 # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
724 "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
725 #
726 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
727 #
728 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
729 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
730 # - projects/project/zones/zone/diskTypes/diskType
731 # - zones/zone/diskTypes/diskType
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]732 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]733 "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
734 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
735 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
736 "licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]737 "A String",
738 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]739 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]740 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]741 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
742 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]743 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]744 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]745 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]746 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
747 "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]748 "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
749 "preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]750 "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]751 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]752 "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]753 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]754 # zones/us-central1-f/machineTypes/n1-standard-1
755 #
756 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
757 #
758 # zones/zone/machineTypes/custom-CPUS-MEMORY
759 #
760 # For example: zones/us-central1-f/machineTypes/custom-4-5120
761 #
762 # For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]763 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]764 { # A service account.
765 "scopes": [ # The list of scopes to be made available for this service account.
766 "A String",
767 ],
768 "email": "A String", # Email address of the service account.
769 },
770 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]771 "networkInterfaces": [ # An 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]772 { # A network interface resource attached to an instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]773 "accessConfigs": [ # An array of configurations for this interface. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]774 { # An access configuration attached to an instance's network interface.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]775 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
776 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]777 "name": "A String", # Name of this access configuration.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]778 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]779 },
780 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]781 "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
782 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]783 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
784 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
785 # - zones/zone/subnetworks/subnetwork
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]786 "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
787 #
788 # global/networks/default
789 #
790 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
791 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
792 # - projects/project/global/networks/network
793 # - global/networks/default
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]794 },
795 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]796 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]797 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
798 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]799 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]800 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
801 {
802 "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.
803 "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.
804 },
805 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]806 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
807 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]808 },
809 }</pre>
810</div>
811
812<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]813 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]814 <pre>Returns the specified instance's serial port output.
815
816Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]817 project: string, Project ID for this request. (required)
818 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]819 instance: string, Name of the instance scoping this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]820 port: integer, Specifies which COM or serial port to retrieve data from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]821
822Returns:
823 An object of the form:
824
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]825 { # An instance's serial console output.
826 "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]827 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]828 "contents": "A String", # [Output Only] The contents of the console output.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]829 }</pre>
830</div>
831
832<div class="method">
833 <code class="details" id="insert">insert(project, zone, body)</code>
834 <pre>Creates an instance resource in the specified project using the data included in the request.
835
836Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]837 project: string, Project ID for this request. (required)
838 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]839 body: object, The request body. (required)
840 The object takes the form of:
841
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]842{ # An Instance resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]843 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
844 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]845 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
846 "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]847 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]848 "zone": "A String", # [Output Only] URL of the zone where the instance resides.
849 "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]850 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
851 "A String",
852 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]853 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
854 #
855 # To see the latest fingerprint, make get() request to the instance.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]856 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]857 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
858 { # An instance-attached disk resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]859 "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]860 #
861 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
862 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
863 "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
864 #
865 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
866 #
867 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
868 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
869 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
870 "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
871 #
872 # global/images/my-private-image
873 #
874 # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
875 #
876 # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
877 #
878 # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
879 "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
880 #
881 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
882 #
883 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
884 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
885 # - projects/project/zones/zone/diskTypes/diskType
886 # - zones/zone/diskTypes/diskType
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]887 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]888 "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
889 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
890 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
891 "licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]892 "A String",
893 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]894 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]895 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]896 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
897 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]898 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]899 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]900 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]901 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
902 "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]903 "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
904 "preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]905 "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]906 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]907 "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]908 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]909 # zones/us-central1-f/machineTypes/n1-standard-1
910 #
911 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
912 #
913 # zones/zone/machineTypes/custom-CPUS-MEMORY
914 #
915 # For example: zones/us-central1-f/machineTypes/custom-4-5120
916 #
917 # For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]918 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]919 { # A service account.
920 "scopes": [ # The list of scopes to be made available for this service account.
921 "A String",
922 ],
923 "email": "A String", # Email address of the service account.
924 },
925 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]926 "networkInterfaces": [ # An 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]927 { # A network interface resource attached to an instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]928 "accessConfigs": [ # An array of configurations for this interface. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]929 { # An access configuration attached to an instance's network interface.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]930 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
931 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]932 "name": "A String", # Name of this access configuration.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]933 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]934 },
935 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]936 "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
937 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]938 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
939 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
940 # - zones/zone/subnetworks/subnetwork
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]941 "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
942 #
943 # global/networks/default
944 #
945 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
946 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
947 # - projects/project/global/networks/network
948 # - global/networks/default
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]949 },
950 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]951 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]952 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
953 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]954 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]955 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
956 {
957 "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.
958 "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.
959 },
960 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]961 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
962 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]963 },
964}
965
966
967Returns:
968 An object of the form:
969
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]970 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]971 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
972 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]973 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]974 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
975 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
976 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
977 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]978 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]979 "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.
980 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]981 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]982 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
983 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]984 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]985 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]986 "message": "A String", # [Output Only] A human-readable description of the warning code.
987 "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.
988 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
989 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]990 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]991 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]992 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]993 },
994 ],
995 },
996 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]997 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]998 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
999 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1000 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1001 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1002 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1003 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1004 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1005 "message": "A String", # [Output Only] An optional, human-readable error message.
1006 "code": "A String", # [Output Only] The error type identifier for this error.
1007 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1008 },
1009 ],
1010 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1011 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1012 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1013 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1014 }</pre>
1015</div>
1016
1017<div class="method">
1018 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1019 <pre>Retrieves the list of instances contained within the specified zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1020
1021Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1022 project: string, Project ID for this request. (required)
1023 zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1024 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.
1025 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.
1026 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1027
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1028The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1029
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1030For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
1031
1032Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
1033
1034The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1035
1036Returns:
1037 An object of the form:
1038
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1039 { # Contains a list of instances.
1040 "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.
1041 "items": [ # [Output Only] A list of instances.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1042 { # An Instance resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1043 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
1044 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1045 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
1046 "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1047 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1048 "zone": "A String", # [Output Only] URL of the zone where the instance resides.
1049 "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1050 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
1051 "A String",
1052 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1053 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
1054 #
1055 # To see the latest fingerprint, make get() request to the instance.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1056 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1057 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
1058 { # An instance-attached disk resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1059 "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1060 #
1061 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
1062 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
1063 "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
1064 #
1065 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
1066 #
1067 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
1068 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
1069 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
1070 "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
1071 #
1072 # global/images/my-private-image
1073 #
1074 # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
1075 #
1076 # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
1077 #
1078 # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
1079 "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
1080 #
1081 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
1082 #
1083 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
1084 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
1085 # - projects/project/zones/zone/diskTypes/diskType
1086 # - zones/zone/diskTypes/diskType
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1087 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1088 "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
1089 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
1090 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
1091 "licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1092 "A String",
1093 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1094 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1095 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1096 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
1097 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1098 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1099 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1100 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1101 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
1102 "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1103 "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
1104 "preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1105 "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1106 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1107 "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1108 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1109 # zones/us-central1-f/machineTypes/n1-standard-1
1110 #
1111 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
1112 #
1113 # zones/zone/machineTypes/custom-CPUS-MEMORY
1114 #
1115 # For example: zones/us-central1-f/machineTypes/custom-4-5120
1116 #
1117 # For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1118 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1119 { # A service account.
1120 "scopes": [ # The list of scopes to be made available for this service account.
1121 "A String",
1122 ],
1123 "email": "A String", # Email address of the service account.
1124 },
1125 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1126 "networkInterfaces": [ # An 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1127 { # A network interface resource attached to an instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1128 "accessConfigs": [ # An array of configurations for this interface. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1129 { # An access configuration attached to an instance's network interface.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1130 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
1131 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1132 "name": "A String", # Name of this access configuration.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1133 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1134 },
1135 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1136 "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
1137 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1138 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
1139 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
1140 # - zones/zone/subnetworks/subnetwork
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1141 "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
1142 #
1143 # global/networks/default
1144 #
1145 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
1146 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
1147 # - projects/project/global/networks/network
1148 # - global/networks/default
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1149 },
1150 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1151 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1152 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1153 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1154 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1155 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
1156 {
1157 "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.
1158 "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.
1159 },
1160 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1161 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
1162 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1163 },
1164 },
1165 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1166 "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1167 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1168 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1169 }</pre>
1170</div>
1171
1172<div class="method">
1173 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1174 <pre>Retrieves the next page of results.
1175
1176Args:
1177 previous_request: The request for the previous page. (required)
1178 previous_response: The response from the request for the previous page. (required)
1179
1180Returns:
1181 A request object that you can call 'execute()' on to request the next
1182 page. Returns None if there are no more items in the collection.
1183 </pre>
1184</div>
1185
1186<div class="method">
1187 <code class="details" id="reset">reset(project, zone, instance)</code>
1188 <pre>Performs a hard reset on the instance.
1189
1190Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1191 project: string, Project ID for this request. (required)
1192 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1193 instance: string, Name of the instance scoping this request. (required)
1194
1195Returns:
1196 An object of the form:
1197
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1198 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1199 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1200 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1201 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1203 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1204 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1205 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1206 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1207 "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.
1208 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1209 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1210 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1211 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1212 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1213 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1214 "message": "A String", # [Output Only] A human-readable description of the warning code.
1215 "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.
1216 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1217 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1218 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1219 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1220 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1221 },
1222 ],
1223 },
1224 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1225 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1226 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1227 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1228 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1229 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1230 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1231 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1232 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1233 "message": "A String", # [Output Only] An optional, human-readable error message.
1234 "code": "A String", # [Output Only] The error type identifier for this error.
1235 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1236 },
1237 ],
1238 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1239 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1240 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1241 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1242 }</pre>
1243</div>
1244
1245<div class="method">
1246 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1247 <pre>Sets the auto-delete flag for a disk attached to an instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1248
1249Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1250 project: string, Project ID for this request. (required)
1251 zone: string, The name of the zone for this request. (required)
1252 instance: string, The instance name. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1253 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1254 deviceName: string, The device name of the disk to modify. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1255
1256Returns:
1257 An object of the form:
1258
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1259 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1260 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1261 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1262 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1263 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1264 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1265 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1266 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1267 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1268 "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.
1269 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1270 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1271 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1272 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1273 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1274 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1275 "message": "A String", # [Output Only] A human-readable description of the warning code.
1276 "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.
1277 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1278 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1279 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1280 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1281 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1282 },
1283 ],
1284 },
1285 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1286 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1287 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1288 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1289 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1290 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1291 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1292 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1293 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1294 "message": "A String", # [Output Only] An optional, human-readable error message.
1295 "code": "A String", # [Output Only] The error type identifier for this error.
1296 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1297 },
1298 ],
1299 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1300 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1301 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1302 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
1303 }</pre>
1304</div>
1305
1306<div class="method">
1307 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
1308 <pre>Changes the machine type for a stopped instance to the machine type specified in the request.
1309
1310Args:
1311 project: string, Project ID for this request. (required)
1312 zone: string, The name of the zone for this request. (required)
1313 instance: string, Name of the instance scoping this request. (required)
1314 body: object, The request body. (required)
1315 The object takes the form of:
1316
1317{
1318 "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
1319 }
1320
1321
1322Returns:
1323 An object of the form:
1324
1325 { # An Operation resource, used to manage asynchronous API requests.
1326 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1327 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1328 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1329 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1330 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1331 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1332 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1333 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1334 "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.
1335 "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.
1336 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1337 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1338 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1339 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1340 {
1341 "message": "A String", # [Output Only] A human-readable description of the warning code.
1342 "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.
1343 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1344 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1345 {
1346 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1347 "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).
1348 },
1349 ],
1350 },
1351 ],
1352 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1353 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1354 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1355 "name": "A String", # [Output Only] Name of the resource.
1356 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1357 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1358 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1359 {
1360 "message": "A String", # [Output Only] An optional, human-readable error message.
1361 "code": "A String", # [Output Only] The error type identifier for this error.
1362 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
1363 },
1364 ],
1365 },
1366 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1367 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1368 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1369 }</pre>
1370</div>
1371
1372<div class="method">
1373 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
1374 <pre>Sets metadata for the specified instance to the data included in the request.
1375
1376Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1377 project: string, Project ID for this request. (required)
1378 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1379 instance: string, Name of the instance scoping this request. (required)
1380 body: object, The request body. (required)
1381 The object takes the form of:
1382
1383{ # A metadata key/value entry.
1384 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
1385 {
1386 "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.
1387 "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.
1388 },
1389 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1390 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
1391 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1392}
1393
1394
1395Returns:
1396 An object of the form:
1397
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1398 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1399 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1400 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1401 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1402 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1403 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1404 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1405 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1406 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1407 "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.
1408 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1409 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1410 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1411 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1412 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1413 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1414 "message": "A String", # [Output Only] A human-readable description of the warning code.
1415 "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.
1416 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1417 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1418 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1419 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1420 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1421 },
1422 ],
1423 },
1424 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1425 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1426 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1427 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1428 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1429 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1430 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1431 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1432 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1433 "message": "A String", # [Output Only] An optional, human-readable error message.
1434 "code": "A String", # [Output Only] The error type identifier for this error.
1435 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1436 },
1437 ],
1438 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1439 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1440 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1441 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1442 }</pre>
1443</div>
1444
1445<div class="method">
1446 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
1447 <pre>Sets an instance's scheduling options.
1448
1449Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1450 project: string, Project ID for this request. (required)
1451 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1452 instance: string, Instance name. (required)
1453 body: object, The request body. (required)
1454 The object takes the form of:
1455
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1456{ # Sets the scheduling options for an Instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1457 "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
1458 "preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1459 "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1460}
1461
1462
1463Returns:
1464 An object of the form:
1465
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1466 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1467 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1468 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1469 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1470 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1471 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1472 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1473 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1474 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1475 "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.
1476 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1477 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1478 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1479 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1480 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1481 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1482 "message": "A String", # [Output Only] A human-readable description of the warning code.
1483 "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.
1484 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1485 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1486 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1487 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1488 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1489 },
1490 ],
1491 },
1492 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1493 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1494 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1495 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1496 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1497 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1498 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1499 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1500 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1501 "message": "A String", # [Output Only] An optional, human-readable error message.
1502 "code": "A String", # [Output Only] The error type identifier for this error.
1503 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1504 },
1505 ],
1506 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1507 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1508 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1509 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1510 }</pre>
1511</div>
1512
1513<div class="method">
1514 <code class="details" id="setTags">setTags(project, zone, instance, body)</code>
1515 <pre>Sets tags for the specified instance to the data included in the request.
1516
1517Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1518 project: string, Project ID for this request. (required)
1519 zone: string, The name of the zone for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1520 instance: string, Name of the instance scoping this request. (required)
1521 body: object, The request body. (required)
1522 The object takes the form of:
1523
1524{ # A set of instance tags.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1525 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
1526 "A String",
1527 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1528 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
1529 #
1530 # To see the latest fingerprint, make get() request to the instance.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1531}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1532
1533
1534Returns:
1535 An object of the form:
1536
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1537 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1538 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1539 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1540 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1541 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1542 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1543 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1544 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1545 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1546 "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.
1547 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1548 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1549 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1550 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1551 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1552 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1553 "message": "A String", # [Output Only] A human-readable description of the warning code.
1554 "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.
1555 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1556 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1557 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1558 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1559 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1560 },
1561 ],
1562 },
1563 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1564 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1565 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1566 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1567 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1568 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1569 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1570 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1571 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1572 "message": "A String", # [Output Only] An optional, human-readable error message.
1573 "code": "A String", # [Output Only] The error type identifier for this error.
1574 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1575 },
1576 ],
1577 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1578 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1579 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1580 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1581 }</pre>
1582</div>
1583
1584<div class="method">
1585 <code class="details" id="start">start(project, zone, instance)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1586 <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1587
1588Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1589 project: string, Project ID for this request. (required)
1590 zone: string, The name of the zone for this request. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1591 instance: string, Name of the instance resource to start. (required)
1592
1593Returns:
1594 An object of the form:
1595
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1596 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1597 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1598 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1599 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1600 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1601 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1602 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1603 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1604 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1605 "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.
1606 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1607 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1608 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1609 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1610 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1611 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1612 "message": "A String", # [Output Only] A human-readable description of the warning code.
1613 "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.
1614 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1615 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1616 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1617 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1618 "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).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1619 },
1620 ],
1621 },
1622 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1623 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1624 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1625 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1626 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1627 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1628 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1629 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1630 {
1631 "message": "A String", # [Output Only] An optional, human-readable error message.
1632 "code": "A String", # [Output Only] The error type identifier for this error.
1633 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
1634 },
1635 ],
1636 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1637 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1638 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1639 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1640 }</pre>
1641</div>
1642
1643<div class="method">
1644 <code class="details" id="stop">stop(project, zone, instance)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1645 <pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1646
1647Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1648 project: string, Project ID for this request. (required)
1649 zone: string, The name of the zone for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1650 instance: string, Name of the instance resource to stop. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1651
1652Returns:
1653 An object of the form:
1654
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1655 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1656 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1657 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1658 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1659 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1660 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1661 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1662 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1663 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1664 "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.
1665 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1666 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1667 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1668 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1669 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1670 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1671 "message": "A String", # [Output Only] A human-readable description of the warning code.
1672 "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.
1673 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1674 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1675 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1676 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1677 "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).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1678 },
1679 ],
1680 },
1681 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1682 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1683 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1684 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1685 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1686 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1687 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1688 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1689 {
1690 "message": "A String", # [Output Only] An optional, human-readable error message.
1691 "code": "A String", # [Output Only] The error type identifier for this error.
1692 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
1693 },
1694 ],
1695 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1696 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1697 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]1698 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1699 }</pre>
1700</div>
1701
1702</body></html>