Apigee API . organizations . apis . revisions . deployments

Instance Methods

list(parent, x__xgafv=None)

Lists all deployments of an API proxy revision.

Method Details

list(parent, x__xgafv=None)
Lists all deployments of an API proxy revision.

Args:
  parent: string, Required. Name of the API proxy revision for which to return deployment information
in the following format:
  `organizations/{org}/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:

    {
    "deployments": [ # List of deployments.
      {
        "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.
      },
    ],
  }