Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / afe134b57f8b128308739e62957e5b796e0bc1e9 / . / docs / dyn / appengine_v1beta4.apps.modules.versions.instances.html
blob: 43ad34a539f56135b9d8ccf92c5789bfb3f8c5ec [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a> . <a href="appengine_v1beta4.apps.modules.versions.html">versions</a> . <a href="appengine_v1beta4.apps.modules.versions.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#debug">debug(appsId, modulesId, 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, modulesId, 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, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets instance information.</p>
86<p class="toc_element">
87 <code><a href="#list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists the instances of a version.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="debug">debug(appsId, modulesId, 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/modules/default/versions/v1/instances/instance-1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]99 modulesId: 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.
106 "sshKey": "A String", # Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [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]107 }
108
109 x__xgafv: string, V1 error format.
110
111Returns:
112 An object of the form:
113
114 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]115 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116 "a_key": "", # Properties of the object. Contains field @type with type URL.
117 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]118 "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: Simple to use and understand for most users 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 which 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: 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. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. 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. 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. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119 "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.
120 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
121 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
122 {
123 "a_key": "", # Properties of the object. Contains field @type with type URL.
124 },
125 ],
126 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]127 "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.
128 "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]129 "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.
130 "a_key": "", # Properties of the object. Contains field @type with type URL.
131 },
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
137 <pre>Stops a running instance.
138
139Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]140 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]141 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
142 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
143 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
144 x__xgafv: string, V1 error format.
145
146Returns:
147 An object of the form:
148
149 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]150 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]151 "a_key": "", # Properties of the object. Contains field @type with type URL.
152 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]153 "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: Simple to use and understand for most users 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 which 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: 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. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. 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. 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. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]154 "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.
155 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
156 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
157 {
158 "a_key": "", # Properties of the object. Contains field @type with type URL.
159 },
160 ],
161 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]162 "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.
163 "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]164 "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.
165 "a_key": "", # Properties of the object. Contains field @type with type URL.
166 },
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
172 <pre>Gets instance information.
173
174Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]176 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
177 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
178 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
179 x__xgafv: string, V1 error format.
180
181Returns:
182 An object of the form:
183
184 { # 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]185 "errors": 42, # Number of errors since this instance was started.@OutputOnly
186 "name": "A String", # Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly
187 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly
188 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
189 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
190 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
191 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
192 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
193 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
194 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
195 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
196 "requests": 42, # Number of requests since this instance was started.@OutputOnly
197 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
198 "availability": "A String", # Availability of the instance.@OutputOnly
199 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
200 "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]201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
206 <pre>Lists the instances of a version.
207
208Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]209 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]210 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
211 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
212 pageSize: integer, Maximum results to return per page.
213 pageToken: string, Continuation token for fetching the next page of results.
214 x__xgafv: string, V1 error format.
215
216Returns:
217 An object of the form:
218
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]219 { # Response message for Instances.ListInstances.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]220 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
221 "instances": [ # The instances belonging to the requested version.
222 { # 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]223 "errors": 42, # Number of errors since this instance was started.@OutputOnly
224 "name": "A String", # Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly
225 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly
226 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
227 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
228 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
229 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
230 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
231 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
232 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
233 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
234 "requests": 42, # Number of requests since this instance was started.@OutputOnly
235 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
236 "availability": "A String", # Availability of the instance.@OutputOnly
237 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
238 "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]239 },
240 ],
241 }</pre>
242</div>
243
244<div class="method">
245 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
246 <pre>Retrieves the next page of results.
247
248Args:
249 previous_request: The request for the previous page. (required)
250 previous_response: The response from the request for the previous page. (required)
251
252Returns:
253 A request object that you can call 'execute()' on to request the next
254 page. Returns None if there are no more items in the collection.
255 </pre>
256</div>
257
258</body></html>