# Google App Engine Admin API . apps . services . versions . instances

## Instance Methods

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.

Stops a running instance.

Gets instance information.

Lists the instances of a version.

Retrieves the next page of results.

### Method Details

`debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)`

    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.

    Args:
      appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
      servicesId: string, Part of `name`. See documentation of `appsId`. (required)
      versionsId: string, Part of `name`. See documentation of `appsId`. (required)
      instancesId: string, Part of `name`. See documentation of `appsId`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Request message for `Instances.DebugInstance`.
      }

      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
        "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`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "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 needs # Overview The `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 mapping The `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 uses The 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.
          "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.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "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.
        "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`.
        "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.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

`delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)`

    Stops a running instance.

    Args:
      appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
      servicesId: string, Part of `name`. See documentation of `appsId`. (required)
      versionsId: string, Part of `name`. See documentation of `appsId`. (required)
      instancesId: string, Part of `name`. See documentation of `appsId`. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
        "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`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "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 needs # Overview The `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 mapping The `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 uses The 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.
          "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.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "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.
        "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`.
        "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.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

`get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)`

    Gets instance information.

    Args:
      appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
      servicesId: string, Part of `name`. See documentation of `appsId`. (required)
      versionsId: string, Part of `name`. See documentation of `appsId`. (required)
      instancesId: string, Part of `name`. See documentation of `appsId`. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
        "errors": 42, # Number of errors since this instance was started. @OutputOnly
        "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
        "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
        "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
        "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
        "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
        "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "startTime": "A String", # Time that this instance was started. @OutputOnly
        "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
        "requests": 42, # Number of requests since this instance was started. @OutputOnly
        "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "availability": "A String", # Availability of the instance. @OutputOnly
        "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
      }

`list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)`

    Lists the instances of a version.

    Args:
      appsId: string, Part of `parent`. Name of the parent Version resource. Example: `apps/myapp/services/default/versions/v1`. (required)
      servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
      versionsId: string, Part of `parent`. 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.
          { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
            "errors": 42, # Number of errors since this instance was started. @OutputOnly
            "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
            "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
            "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
            "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
            "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
            "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
            "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
            "startTime": "A String", # Time that this instance was started. @OutputOnly
            "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
            "requests": 42, # Number of requests since this instance was started. @OutputOnly
            "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
            "availability": "A String", # Availability of the instance. @OutputOnly
            "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
            "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
          },
        ],
      }

`list_next(previous_request, previous_response)`

    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.