Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / appengine_v1beta5.apps.services.versions.instances.html
blob: 3f05fcc197c932c96b7a6c564b9409cc63d9265e [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[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="appengine_v1beta5.html">Google App Engine Admin API</a> . <a href="appengine_v1beta5.apps.html">apps</a> . <a href="appengine_v1beta5.apps.services.html">services</a> . <a href="appengine_v1beta5.apps.services.versions.html">versions</a> . <a href="appengine_v1beta5.apps.services.versions.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="#debug">debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]79<p class="firstline">Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
82<p class="firstline">Stops a running instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets instance information.</p>
86<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]87 <code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]88<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94 <code class="details" id="debug">debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]95 <pre>Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96
97Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]98 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]99 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
100 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
101 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]105{ # Request message for Instances.DebugInstance.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]106 "sshKey": "A String", # Public SSH key to add to the instance. Examples:
107 # [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]
108 # [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109 }
110
111 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]115
116Returns:
117 An object of the form:
118
119 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]120 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
121 # Simple to use and understand for most users
122 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
123 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
124 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
125 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
126 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
127 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]128 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
129 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
130 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
131 {
132 "a_key": "", # Properties of the object. Contains field @type with type URL.
133 },
134 ],
135 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]136 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]137 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
138 "a_key": "", # Properties of the object. Contains field @type with type URL.
139 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]140 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]141 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
142 "a_key": "", # Properties of the object. Contains field @type with type URL.
143 },
144 }</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
149 <pre>Stops a running instance.
150
151Args:
152 appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1/instances/instance-1". (required)
153 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
154 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
155 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
156 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160
161Returns:
162 An object of the form:
163
164 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]165 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
166 # Simple to use and understand for most users
167 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
168 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
169 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
170 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
171 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
172 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]173 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
174 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
175 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
176 {
177 "a_key": "", # Properties of the object. Contains field @type with type URL.
178 },
179 ],
180 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]182 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
183 "a_key": "", # Properties of the object. Contains field @type with type URL.
184 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]185 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]186 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
187 "a_key": "", # Properties of the object. Contains field @type with type URL.
188 },
189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
194 <pre>Gets instance information.
195
196Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]197 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
199 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
200 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
201 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]205
206Returns:
207 An object of the form:
208
209 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]210 "errors": 42, # Number of errors since this instance was started.@OutputOnly
211 "name": "A String", # Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]212 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]213 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly
214 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
215 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
216 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]217 "availability": "A String", # Availability of the instance.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]218 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
219 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
220 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
221 "requests": 42, # Number of requests since this instance was started.@OutputOnly
222 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]223 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]224 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
225 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]230 <code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]231 <pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]232
233Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]234 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]235 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
236 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
237 pageSize: integer, Maximum results to return per page.
238 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]242 pageToken: string, Continuation token for fetching the next page of results.
243
244Returns:
245 An object of the form:
246
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]247 { # Response message for Instances.ListInstances.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]248 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
249 "instances": [ # The instances belonging to the requested version.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]250 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]251 "errors": 42, # Number of errors since this instance was started.@OutputOnly
252 "name": "A String", # Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]253 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]254 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly
255 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
256 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
257 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]258 "availability": "A String", # Availability of the instance.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]259 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
260 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
261 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
262 "requests": 42, # Number of requests since this instance was started.@OutputOnly
263 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]264 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]265 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
266 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]267 },
268 ],
269 }</pre>
270</div>
271
272<div class="method">
273 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
274 <pre>Retrieves the next page of results.
275
276Args:
277 previous_request: The request for the previous page. (required)
278 previous_response: The response from the request for the previous page. (required)
279
280Returns:
281 A request object that you can call 'execute()' on to request the next
282 page. Returns None if there are no more items in the collection.
283 </pre>
284</div>
285
286</body></html>