blob: 87d2deb0bb18dd0fedf0621a71bbb9966ab185b1 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
<p class="firstline">Lists the instances of a version.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
<pre>Lists the instances of a version.
Args:
appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
x__xgafv: string, V1 error format.
pageToken: string, Continuation token for fetching the next page of results.
Returns:
An object of the form:
{ # Response message for `Instances.ListInstances`.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"instances": [ # The instances belonging to the requested version.
{ # Instances are the computing units that App Engine uses to automatically scale an application.
"errors": 42, # Number of errors since the instance was started. @OutputOnly
"name": "A String", # The full path to the Instance resource in the API. Example: "apps/myapp/services/default/versions/v1/instances/instance-1" @OutputOnly
"startTimestamp": "A String", # Time when instance was started. @OutputOnly
"appEngineRelease": "A String", # The App Engine release the instance is running on. @OutputOnly
"vmId": "A String", # For VMEngines instances, the GCE VM ID of the instance. @OutputOnly
"memoryUsage": "A String", # Memory usage (in bytes). @OutputOnly
"id": "A String", # The relative name/path of the instance within the version. Example: "instance-1" @OutputOnly
"vmUnlocked": True or False, # For VMEngines instances, whether the instance has been unlocked. @OutputOnly
"averageLatency": 42, # Latency in milliseconds (averaged over the last minute). @OutputOnly
"qps": 3.14, # QPS for this instance (averaged over the last minute). @OutputOnly
"requests": 42, # Number of requests (since the clone was started). @OutputOnly
"vmName": "A String", # For VMEngines instances, the name of GCE VM where the instance lives. @OutputOnly
"availability": "A String", # Availability of instance. @OutputOnly
"vmZoneName": "A String", # For VMEngines instances, the zone where the GCE VM is located. @OutputOnly
"vmStatus": "A String", # For VMEngines instances, the status of GCE VM where the instance lives. @OutputOnly
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>