| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.apis.html">apis</a> . <a href="apigee_v1.organizations.environments.apis.deployments.html">deployments</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all deployments of an API proxy in an environment.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| <pre>Lists all deployments of an API proxy in an environment. |
| |
| Args: |
| parent: string, Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` (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. |
| { |
| "instances": [ # Status reported by each runtime instance. This field is not populated in List APIs. |
| { # The status of a deployment as reported by a single instance. |
| "deployedRoutes": [ # The current routes deployed in the ingress routing table. A route which is missing will appear in missing_routes. |
| { # A route deployed in the ingress routing table. |
| "environment": "A String", # The destination environment. This will be empty if the route is not yet reported. |
| "percentage": 42, # The percentage of ingress replicas reporting this route. |
| "envgroup": "A String", # The envgroup where this route is installed. |
| "basepath": "A String", # The basepath in the routing table. |
| }, |
| ], |
| "deployedRevisions": [ # Revisions currently deployed in MPs. |
| { # Revisions deployed in the MPs. |
| "percentage": 42, # The percentage of MP replicas reporting this revision |
| "revision": "A String", # The proxy revision reported as deployed. |
| }, |
| ], |
| "instance": "A String", # ID of the instance reporting the status. |
| }, |
| ], |
| "environment": "A String", # Environment. |
| "revision": "A String", # API proxy revision. |
| "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. |
| "routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployments basepaths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. This field is not populated in List APIs. |
| { # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath. |
| "description": "A String", # A human-readable description of this conflict. |
| "conflictingDeployment": { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict. |
| "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath. |
| "revision": "A String", # The name of the deployed proxy revision containing the basepath. |
| "environment": "A String", # The name of the environment in which the proxy is deployed. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| "environmentGroup": "A String", # The name of the environment group in which this conflict exists. |
| }, |
| ], |
| "pods": [ # Status reported by runtime pods. This field is not populated for List APIs. |
| { |
| "appVersion": "A String", # Version of the application running in the pod. |
| "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. |
| "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch. |
| "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch. |
| "statusCodeDetails": "A String", # Human-readable message associated with the status code. |
| "deploymentTime": "A String", # Time the proxy was deployed 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. |
| }, |
| ], |
| "state": "A String", # Current state of the deployment. This field is not populated in List APIs. |
| "errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs. |
| { # 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). |
| "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. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| }, |
| ], |
| "apiProxy": "A String", # API proxy. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
