Apigee API . organizations . environments . apis . revisions

Instance Methods

debugsessions()

Returns the debugsessions Resource.

deployments(name, x__xgafv=None)

Undeploys an API proxy revision from an environment.

getDeployments(name, x__xgafv=None)

Gets the deployment of an API proxy revision and actual state reported by

Method Details

deployments(name, x__xgafv=None)
Undeploys an API proxy revision from an environment.

Because multiple revisions of the same API proxy can be deployed in
the same environment if the base paths are different, you must specify the
revision number of the API proxy.

Args:
  name: string, Required. Name of the API proxy revision deployment in the following format:
  `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
getDeployments(name, x__xgafv=None)
Gets the deployment of an API proxy revision and actual state reported by
runtime pods.

Args:
  name: string, Required. Name representing an API proxy revision in an
environment in the following format:
  `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "pods": [ # Status reported by runtime pods.
      {
        "statusCodeDetails": "A String", # Human-readable message associated with the status code.
        "deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch.
        "statusCode": "A String", # Code associated with the deployment status.
        "podStatus": "A String", # Overall status of the pod (not this specific deployment). Valid values
            # include:
            # - `active`: Up to date.
            # - `stale` : Recently out of date.
            #
            # Pods that have not reported status in a
            # long time are excluded from the output.
        "podName": "A String", # Name of the pod which is reporting the status.
        "appVersion": "A String", # Version of the application running in the pod.
        "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch.
        "deploymentStatus": "A String", # Status of the deployment. Valid values
            # include:
            # - `deployed`: Successful.
            # - `error` : Failed.
            # - `pending` : Pod has not yet reported on the deployment.
        "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch.
      },
    ],
    "environment": "A String", # Environment.
    "basePath": "A String", # Base path for the deployment.
    "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in
        # millisconds since epoch.
    "apiProxy": "A String", # API proxy.
    "revision": "A String", # API proxy revision.
  }