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_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a> . <a href="appengine_v1.apps.services.versions.html">versions</a> . <a href="appengine_v1.apps.services.versions.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#debug">debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)</a></code></p> 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> 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"> 87 <code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 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> 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, servicesId, versionsId, instancesId, body, x__xgafv=None)</code> 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. 96 97Args: 98 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required) 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 105{ # Request message for Instances.DebugInstance. 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). 109 } 110 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 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. 120 "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. 121 "a_key": "", # Properties of the object. Contains field @type with type URL. 122 }, 123 "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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 124 "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. 125 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 126 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 127 { 128 "a_key": "", # Properties of the object. Contains field @type with type URL. 129 }, 130 ], 131 }, 132 "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. 133 "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. 134 "a_key": "", # Properties of the object. Contains field @type with type URL. 135 }, 136 "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 be a resource name ending with operations/{unique_id}. 137 }</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code> 142 <pre>Stops a running instance. 143 144Args: 145 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required) 146 servicesId: string, Part of `name`. See documentation of `appsId`. (required) 147 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 148 instancesId: string, Part of `name`. See documentation of `appsId`. (required) 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # This resource represents a long-running operation that is the result of a network API call. 158 "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. 159 "a_key": "", # Properties of the object. Contains field @type with type URL. 160 }, 161 "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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 162 "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. 163 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 164 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 165 { 166 "a_key": "", # Properties of the object. Contains field @type with type URL. 167 }, 168 ], 169 }, 170 "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. 171 "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. 172 "a_key": "", # Properties of the object. Contains field @type with type URL. 173 }, 174 "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 be a resource name ending with operations/{unique_id}. 175 }</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code> 180 <pre>Gets instance information. 181 182Args: 183 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required) 184 servicesId: string, Part of `name`. See documentation of `appsId`. (required) 185 versionsId: string, Part of `name`. See documentation of `appsId`. (required) 186 instancesId: string, Part of `name`. See documentation of `appsId`. (required) 187 x__xgafv: string, V1 error format. 188 Allowed values 189 1 - v1 error format 190 2 - v2 error format 191 192Returns: 193 An object of the form: 194 195 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application. 196 "errors": 42, # Number of errors since this instance was started.@OutputOnly 197 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 198 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly 199 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 200 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly 201 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly 202 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly 203 "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly 204 "startTime": "A String", # Time that this instance was started.@OutputOnly 205 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 206 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly 207 "requests": 42, # Number of requests since this instance was started.@OutputOnly 208 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 209 "availability": "A String", # Availability of the instance.@OutputOnly 210 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@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 212 }</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code> 217 <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). 218 219Args: 220 appsId: string, Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. (required) 221 servicesId: string, Part of `parent`. See documentation of `appsId`. (required) 222 versionsId: string, Part of `parent`. See documentation of `appsId`. (required) 223 pageSize: integer, Maximum results to return per page. 224 pageToken: string, Continuation token for fetching the next page of results. 225 x__xgafv: string, V1 error format. 226 Allowed values 227 1 - v1 error format 228 2 - v2 error format 229 230Returns: 231 An object of the form: 232 233 { # Response message for Instances.ListInstances. 234 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 235 "instances": [ # The instances belonging to the requested version. 236 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application. 237 "errors": 42, # Number of errors since this instance was started.@OutputOnly 238 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 239 "appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly 240 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 241 "memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly 242 "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly 243 "averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly 244 "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly 245 "startTime": "A String", # Time that this instance was started.@OutputOnly 246 "vmIp": "A String", # The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly 247 "qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly 248 "requests": 42, # Number of requests since this instance was started.@OutputOnly 249 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly 250 "availability": "A String", # Availability of the instance.@OutputOnly 251 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@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 253 }, 254 ], 255 }</pre> 256</div> 257 258<div class="method"> 259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 260 <pre>Retrieves the next page of results. 261 262Args: 263 previous_request: The request for the previous page. (required) 264 previous_response: The response from the request for the previous page. (required) 265 266Returns: 267 A request object that you can call 'execute()' on to request the next 268 page. Returns None if there are no more items in the collection. 269 </pre> 270</div> 271 272</body></html>