Debian Codegraph @

docs/dyn/apigee_v1.organizations.environments.apis.deployments.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.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>
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, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lists all deployments of an API proxy in an environment.</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, x__xgafv=None)</code>
91 <pre>Lists all deployments of an API proxy in an environment.
92
93 Args:
94 parent: string, Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100 Returns:
101 An object of the form:
102
103 {
104 &quot;deployments&quot;: [ # List of deployments.
105 { # Deployment represents a deployment of an API proxy or shared flow.
106 &quot;apiProxy&quot;: &quot;A String&quot;, # API proxy.
107 &quot;deployStartTime&quot;: &quot;A String&quot;, # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.
108 &quot;environment&quot;: &quot;A String&quot;, # Environment.
109 &quot;errors&quot;: [ # Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status.
110 { # 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).
111 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
112 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
113 {
114 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
115 },
116 ],
117 &quot;message&quot;: &quot;A String&quot;, # 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.
118 },
119 ],
120 &quot;instances&quot;: [ # Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status.
121 { # The status of a deployment as reported by a single instance.
122 &quot;deployedRevisions&quot;: [ # Revisions currently deployed in MPs.
123 { # Revisions deployed in the MPs.
124 &quot;percentage&quot;: 42, # Percentage of MP replicas reporting this revision.
125 &quot;revision&quot;: &quot;A String&quot;, # API proxy revision reported as deployed.
126 },
127 ],
128 &quot;deployedRoutes&quot;: [ # Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`.
129 { # Route deployed in the ingress routing table.
130 &quot;basepath&quot;: &quot;A String&quot;, # Base path in the routing table.
131 &quot;envgroup&quot;: &quot;A String&quot;, # Environment group where this route is installed.
132 &quot;environment&quot;: &quot;A String&quot;, # Destination environment. This will be empty if the route is not yet reported.
133 &quot;percentage&quot;: 42, # Percentage of ingress replicas reporting this route.
134 },
135 ],
136 &quot;instance&quot;: &quot;A String&quot;, # ID of the instance reporting the status.
137 },
138 ],
139 &quot;pods&quot;: [ # Status reported by runtime pods. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status.
140 {
141 &quot;appVersion&quot;: &quot;A String&quot;, # Version of the application running in the pod.
142 &quot;deploymentStatus&quot;: &quot;A String&quot;, # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.
143 &quot;deploymentStatusTime&quot;: &quot;A String&quot;, # Time the deployment status was reported in milliseconds since epoch.
144 &quot;deploymentTime&quot;: &quot;A String&quot;, # Time the proxy was deployed in milliseconds since epoch.
145 &quot;podName&quot;: &quot;A String&quot;, # Name of the pod which is reporting the status.
146 &quot;podStatus&quot;: &quot;A String&quot;, # 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.
147 &quot;podStatusTime&quot;: &quot;A String&quot;, # Time the pod status was reported in milliseconds since epoch.
148 &quot;statusCode&quot;: &quot;A String&quot;, # Code associated with the deployment status.
149 &quot;statusCodeDetails&quot;: &quot;A String&quot;, # Human-readable message associated with the status code.
150 },
151 ],
152 &quot;proxyDeploymentType&quot;: &quot;A String&quot;, # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
153 &quot;revision&quot;: &quot;A String&quot;, # API proxy revision.
154 &quot;routeConflicts&quot;: [ # 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&#x27;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. **Note**: This field is displayed only when viewing deployment status.
155 { # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
156 &quot;conflictingDeployment&quot;: { # Tuple representing a base path and the deployment containing it. # Existing base path/deployment causing the conflict.
157 &quot;apiProxy&quot;: &quot;A String&quot;, # Name of the deployed API proxy revision containing the base path.
158 &quot;basepath&quot;: &quot;A String&quot;, # Base path receiving traffic.
159 &quot;environment&quot;: &quot;A String&quot;, # Name of the environment in which the proxy is deployed.
160 &quot;revision&quot;: &quot;A String&quot;, # Name of the deployed API proxy revision containing the base path.
161 },
162 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of this conflict.
163 &quot;environmentGroup&quot;: &quot;A String&quot;, # Name of the environment group in which this conflict exists.
164 },
165 ],
166 &quot;serviceAccount&quot;: &quot;A String&quot;, # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
167 &quot;state&quot;: &quot;A String&quot;, # Current state of the deployment. **Note**: This field is displayed only when viewing deployment status.
168 },
169 ],
170 }</pre>
171 </div>
172
173 </body></html>