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">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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#debug">debug(appsId, modulesId, versionsId, instancesId, body=None, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p> 85<p class="firstline">Stops a running instance.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets instance information.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<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> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="debug">debug(appsId, modulesId, versionsId, instancesId, body=None, x__xgafv=None)</code> 103 <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. 104 105Args: 106 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. (required) 107 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 108 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 109 instancesId: string, Part of `name`. See documentation of `appsId`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Request message for Instances.DebugInstance. 114 "sshKey": "A String", # Public SSH key to add to the instance. Examples: 115 # [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] 116 # [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). 117} 118 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # This resource represents a long-running operation that is the result of a network API call. 128 "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. 129 "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. 130 # Simple to use and understand for most users 131 # 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: 132 # 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. 133 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 134 # 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. 135 # 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. 136 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 137 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 138 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 139 { 140 "a_key": "", # Properties of the object. Contains field @type with type URL. 141 }, 142 ], 143 "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. 144 }, 145 "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. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "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. 149 "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. 150 "a_key": "", # Properties of the object. Contains field @type with type URL. 151 }, 152}</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code> 157 <pre>Stops a running instance. 158 159Args: 160 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. (required) 161 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 162 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 163 instancesId: string, Part of `name`. See documentation of `appsId`. (required) 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169Returns: 170 An object of the form: 171 172 { # This resource represents a long-running operation that is the result of a network API call. 173 "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. 174 "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. 175 # Simple to use and understand for most users 176 # 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: 177 # 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. 178 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 179 # 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. 180 # 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. 181 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 182 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 183 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 184 { 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187 ], 188 "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. 189 }, 190 "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. 191 "a_key": "", # Properties of the object. Contains field @type with type URL. 192 }, 193 "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. 194 "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. 195 "a_key": "", # Properties of the object. Contains field @type with type URL. 196 }, 197}</pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code> 202 <pre>Gets instance information. 203 204Args: 205 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. (required) 206 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 207 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 208 instancesId: string, Part of `name`. See documentation of `appsId`. (required) 209 x__xgafv: string, V1 error format. 210 Allowed values 211 1 - v1 error format 212 2 - v2 error format 213 214Returns: 215 An object of the form: 216 217 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application. 218 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly 219 "availability": "A String", # Availability of the instance.@OutputOnly 220 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly 221 "errors": 42, # Number of errors since this instance was started.@OutputOnly 222 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly 223 "memoryUsage": "A String", # Total memory in use (bytes).@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 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly 226 "requests": 42, # Number of requests since this instance was started.@OutputOnly 227 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly 228 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 229 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 230 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 231 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 232 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly 233 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly 234}</pre> 235</div> 236 237<div class="method"> 238 <code class="details" id="list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code> 239 <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). 240 241Args: 242 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. (required) 243 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 244 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 245 pageSize: integer, Maximum results to return per page. 246 pageToken: string, Continuation token for fetching the next page of results. 247 x__xgafv: string, V1 error format. 248 Allowed values 249 1 - v1 error format 250 2 - v2 error format 251 252Returns: 253 An object of the form: 254 255 { # Response message for Instances.ListInstances. 256 "instances": [ # The instances belonging to the requested version. 257 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application. 258 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly 259 "availability": "A String", # Availability of the instance.@OutputOnly 260 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly 261 "errors": 42, # Number of errors since this instance was started.@OutputOnly 262 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly 263 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly 264 "name": "A String", # Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly 265 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly 266 "requests": 42, # Number of requests since this instance was started.@OutputOnly 267 "startTimestamp": "A String", # Time that this instance was started.@OutputOnly 268 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 269 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 270 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 271 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 272 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly 273 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly 274 }, 275 ], 276 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 277}</pre> 278</div> 279 280<div class="method"> 281 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 282 <pre>Retrieves the next page of results. 283 284Args: 285 previous_request: The request for the previous page. (required) 286 previous_response: The response from the request for the previous page. (required) 287 288Returns: 289 A request object that you can call 'execute()' on to request the next 290 page. Returns None if there are no more items in the collection. 291 </pre> 292</div> 293 294</body></html>