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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.deployments.html">deployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(parent, sharedFlows=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Lists all deployments of API proxies or shared flows.</p> 83<h3>Method Details</h3> 84<div class="method"> 85 <code class="details" id="close">close()</code> 86 <pre>Close httplib2 connections.</pre> 87</div> 88 89<div class="method"> 90 <code class="details" id="list">list(parent, sharedFlows=None, x__xgafv=None)</code> 91 <pre>Lists all deployments of API proxies or shared flows. 92 93Args: 94 parent: string, Required. Name of the organization for which to return deployment information in the following format: `organizations/{org}` (required) 95 sharedFlows: boolean, Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`. 96 x__xgafv: string, V1 error format. 97 Allowed values 98 1 - v1 error format 99 2 - v2 error format 100 101Returns: 102 An object of the form: 103 104 { 105 "deployments": [ # List of deployments. 106 { 107 "apiProxy": "A String", # API proxy. 108 "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. 109 "environment": "A String", # Environment. 110 "errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs. 111 { # 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). 112 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 113 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 114 { 115 "a_key": "", # Properties of the object. Contains field @type with type URL. 116 }, 117 ], 118 "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. 119 }, 120 ], 121 "instances": [ # Status reported by each runtime instance. This field is not populated in List APIs. 122 { # The status of a deployment as reported by a single instance. 123 "deployedRevisions": [ # Revisions currently deployed in MPs. 124 { # Revisions deployed in the MPs. 125 "percentage": 42, # Percentage of MP replicas reporting this revision. 126 "revision": "A String", # API proxy revision reported as deployed. 127 }, 128 ], 129 "deployedRoutes": [ # Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`. 130 { # Route deployed in the ingress routing table. 131 "basepath": "A String", # Base path in the routing table. 132 "envgroup": "A String", # Environment group where this route is installed. 133 "environment": "A String", # Destination environment. This will be empty if the route is not yet reported. 134 "percentage": 42, # Percentage of ingress replicas reporting this route. 135 }, 136 ], 137 "instance": "A String", # ID of the instance reporting the status. 138 }, 139 ], 140 "pods": [ # Status reported by runtime pods. This field is not populated for List APIs. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status. 141 { 142 "appVersion": "A String", # Version of the application running in the pod. 143 "deploymentStatus": "A String", # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment. 144 "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch. 145 "deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch. 146 "podName": "A String", # Name of the pod which is reporting the status. 147 "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. 148 "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch. 149 "statusCode": "A String", # Code associated with the deployment status. 150 "statusCodeDetails": "A String", # Human-readable message associated with the status code. 151 }, 152 ], 153 "revision": "A String", # API proxy revision. 154 "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 deployment's base paths 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. 155 { # Describes a routing conflict that may cause a deployment not to receive traffic at some base path. 156 "conflictingDeployment": { # Tuple representing a base path and the deployment containing it. # Existing base path/deployment causing the conflict. 157 "apiProxy": "A String", # Name of the deployed API proxy revision containing the base path. 158 "basepath": "A String", # Base path receiving traffic. 159 "environment": "A String", # Name of the environment in which the proxy is deployed. 160 "revision": "A String", # Name of the deployed API proxy revision containing the base path. 161 }, 162 "description": "A String", # Human-readable description of this conflict. 163 "environmentGroup": "A String", # Name of the environment group in which this conflict exists. 164 }, 165 ], 166 "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. 167 "state": "A String", # Current state of the deployment. This field is not populated in List APIs. 168 }, 169 ], 170}</pre> 171</div> 172 173</body></html>