blob: f29ee482de6b802241bccf751528cf47a2a49eda [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001<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.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="apigee_v1.organizations.instances.attachments.html">attachments()</a></code>
79</p>
80<p class="firstline">Returns the attachments Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070086 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070087<p class="firstline">Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070088<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090<p class="firstline">Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070091<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093<p class="firstline">Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094<p class="toc_element">
95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096<p class="firstline">Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#reportStatus">reportStatus(instance, body=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Reports the latest status for a runtime instance.</p>
103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109<div class="method">
110 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
111 <pre>Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700112
113Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115 body: object, The request body.
116 The object takes the form of:
117
118{ # Apigee runtime instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120 &quot;location&quot;: &quot;A String&quot;, # Required. Compute Engine location where the instance resides.
121 &quot;name&quot;: &quot;A String&quot;, # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
122 &quot;diskEncryptionKeyName&quot;: &quot;A String&quot;, # Optional. Customer Managed Encryption Key (CMEK) used for disk &amp; volume encryption.
123 &quot;createdAt&quot;: &quot;A String&quot;, # Output only. Time the instance was created in milliseconds since epoch.
124 &quot;port&quot;: &quot;A String&quot;, # Output only. Port number of the exposed Apigee endpoint.
125 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
126 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name for the instance.
127 &quot;lastModifiedAt&quot;: &quot;A String&quot;, # Output only. Time the instance was last modified in milliseconds since epoch.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700128}
129
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700138 { # This resource represents a long-running operation that is the result of a network API call.
139 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700140 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
141 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
144 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700146 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 {
149 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
150 },
151 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700153 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
155 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700161 <pre>Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700162
163Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700164 name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instance/{instance}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 { # This resource represents a long-running operation that is the result of a network API call.
174 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700177 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
179 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700181 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 {
184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
185 },
186 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700187 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700188 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700189 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
190 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196 <pre>Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700197
198Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700199 name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
208 { # Apigee runtime instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700209 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700210 &quot;location&quot;: &quot;A String&quot;, # Required. Compute Engine location where the instance resides.
211 &quot;name&quot;: &quot;A String&quot;, # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
212 &quot;diskEncryptionKeyName&quot;: &quot;A String&quot;, # Optional. Customer Managed Encryption Key (CMEK) used for disk &amp; volume encryption.
213 &quot;createdAt&quot;: &quot;A String&quot;, # Output only. Time the instance was created in milliseconds since epoch.
214 &quot;port&quot;: &quot;A String&quot;, # Output only. Port number of the exposed Apigee endpoint.
215 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
216 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name for the instance.
217 &quot;lastModifiedAt&quot;: &quot;A String&quot;, # Output only. Time the instance was last modified in milliseconds since epoch.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223 <pre>Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700224
225Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700226 parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700227 pageSize: integer, Maximum number of instances to return. Defaults to 25.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 pageToken: string, Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # Response for ListInstances.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 &quot;instances&quot;: [ # Instances in the specified organization.
239 { # Apigee runtime instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700240 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700241 &quot;location&quot;: &quot;A String&quot;, # Required. Compute Engine location where the instance resides.
242 &quot;name&quot;: &quot;A String&quot;, # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
243 &quot;diskEncryptionKeyName&quot;: &quot;A String&quot;, # Optional. Customer Managed Encryption Key (CMEK) used for disk &amp; volume encryption.
244 &quot;createdAt&quot;: &quot;A String&quot;, # Output only. Time the instance was created in milliseconds since epoch.
245 &quot;port&quot;: &quot;A String&quot;, # Output only. Port number of the exposed Apigee endpoint.
246 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
247 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name for the instance.
248 &quot;lastModifiedAt&quot;: &quot;A String&quot;, # Output only. Time the instance was last modified in milliseconds since epoch.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700249 },
250 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700251 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
257 <pre>Retrieves the next page of results.
258
259Args:
260 previous_request: The request for the previous page. (required)
261 previous_response: The response from the request for the previous page. (required)
262
263Returns:
264 A request object that you can call &#x27;execute()&#x27; on to request the next
265 page. Returns None if there are no more items in the collection.
266 </pre>
267</div>
268
269<div class="method">
270 <code class="details" id="reportStatus">reportStatus(instance, body=None, x__xgafv=None)</code>
271 <pre>Reports the latest status for a runtime instance.
272
273Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274 instance: string, The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance} (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700275 body: object, The request body.
276 The object takes the form of:
277
278{ # Request for ReportInstanceStatus.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700279 &quot;reportTime&quot;: &quot;A String&quot;, # The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it&#x27;s status reports so that clock skew does not play a factor.
280 &quot;instanceUid&quot;: &quot;A String&quot;, # A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700281 &quot;resources&quot;: [ # Status for config resources
282 { # The status of a resource loaded in the runtime.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700283 &quot;totalReplicas&quot;: 42, # The total number of replicas that should have this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700284 &quot;resource&quot;: &quot;A String&quot;, # The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig
285 &quot;uid&quot;: &quot;A String&quot;, # The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700286 &quot;revisions&quot;: [ # Revisions of the resource currently deployed in the instance.
287 { # The status of a specific resource revision.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700288 &quot;errors&quot;: [ # Errors reported when attempting to load this revision.
289 { # Details on why a resource update failed in the runtime.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700290 &quot;type&quot;: &quot;A String&quot;, # A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.
291 &quot;resource&quot;: &quot;A String&quot;, # The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700292 &quot;message&quot;: &quot;A String&quot;, # User-friendly error message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700293 &quot;code&quot;: &quot;A String&quot;, # Status code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700294 },
295 ],
296 &quot;jsonSpec&quot;: &quot;A String&quot;, # The json content of the resource revision.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700297 &quot;replicas&quot;: 42, # The number of replicas that have successfully loaded this revision.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700298 &quot;revisionId&quot;: &quot;A String&quot;, # The revision of the resource.
299 },
300 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700301 },
302 ],
303 }
304
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
313 { # Placeholder for future enhancements to status reporting protocol
314 }</pre>
315</div>
316
317</body></html>