| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| 78 | <code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p> |
| 79 | <p class="firstline">Lists the instances of a version.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code> |
| 86 | <pre>Lists the instances of a version. |
| 87 | |
| 88 | Args: |
| 89 | appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required) |
| 90 | servicesId: string, Part of `name`. See documentation of `appsId`. (required) |
| 91 | versionsId: string, Part of `name`. See documentation of `appsId`. (required) |
| 92 | pageSize: integer, Maximum results to return per page. |
| 93 | x__xgafv: string, V1 error format. |
| 94 | pageToken: string, Continuation token for fetching the next page of results. |
| 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { # Response message for `Instances.ListInstances`. |
| 100 | "nextPageToken": "A String", # Continuation token for fetching the next page of results. |
| 101 | "instances": [ # The instances belonging to the requested version. |
| 102 | { # Instances are the computing units that App Engine uses to automatically scale an application. |
| 103 | "errors": 42, # Number of errors since the instance was started. @OutputOnly |
| 104 | "name": "A String", # The full path to the Instance resource in the API. Example: "apps/myapp/services/default/versions/v1/instances/instance-1" @OutputOnly |
| 105 | "startTimestamp": "A String", # Time when instance was started. @OutputOnly |
| 106 | "appEngineRelease": "A String", # The App Engine release the instance is running on. @OutputOnly |
| 107 | "vmId": "A String", # For VMEngines instances, the GCE VM ID of the instance. @OutputOnly |
| 108 | "memoryUsage": "A String", # Memory usage (in bytes). @OutputOnly |
| 109 | "id": "A String", # The relative name/path of the instance within the version. Example: "instance-1" @OutputOnly |
| 110 | "vmUnlocked": True or False, # For VMEngines instances, whether the instance has been unlocked. @OutputOnly |
| 111 | "averageLatency": 42, # Latency in milliseconds (averaged over the last minute). @OutputOnly |
| 112 | "qps": 3.14, # QPS for this instance (averaged over the last minute). @OutputOnly |
| 113 | "requests": 42, # Number of requests (since the clone was started). @OutputOnly |
| 114 | "vmName": "A String", # For VMEngines instances, the name of GCE VM where the instance lives. @OutputOnly |
| 115 | "availability": "A String", # Availability of instance. @OutputOnly |
| 116 | "vmZoneName": "A String", # For VMEngines instances, the zone where the GCE VM is located. @OutputOnly |
| 117 | "vmStatus": "A String", # For VMEngines instances, the status of GCE VM where the instance lives. @OutputOnly |
| 118 | }, |
| 119 | ], |
| 120 | }</pre> |
| 121 | </div> |
| 122 | |
| 123 | <div class="method"> |
| 124 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 125 | <pre>Retrieves the next page of results. |
| 126 | |
| 127 | Args: |
| 128 | previous_request: The request for the previous page. (required) |
| 129 | previous_response: The response from the request for the previous page. (required) |
| 130 | |
| 131 | Returns: |
| 132 | A request object that you can call 'execute()' on to request the next |
| 133 | page. Returns None if there are no more items in the collection. |
| 134 | </pre> |
| 135 | </div> |
| 136 | |
| 137 | </body></html> |