1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<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.targetservers.html">targetservers</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="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a TargetServer in the specified environment.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a TargetServer resource.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.</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="create">create(parent, body=None, name=None, x__xgafv=None)</code>
<pre>Creates a TargetServer in the specified environment.
Args:
parent: string, Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`. (required)
body: object, The request body.
The object takes the form of:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}
name: string, Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.
Args:
name: string, Required. The name of the TargetServer to delete. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a TargetServer resource.
Args:
name: string, Required. The name of the TargetServer to get. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.
Args:
name: string, Required. The name of the TargetServer to replace. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
"description": "A String", # Optional. A human-readable description of this TargetServer.
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression
"port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
"protocol": "A String", # Immutable. The protocol used by this TargetServer.
"sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
"ciphers": [ # The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
"A String",
],
"clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
"commonName": { # The TLS Common Name of the certificate.
"value": "A String", # The TLS Common Name string of the certificate.
"wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
},
"enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
"enforce": True or False, # TLS is strictly enforced.
"ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
"keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
"keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore.
"protocols": [ # The TLS versioins to be used.
"A String",
],
"trustStore": "A String", # The resource ID of the truststore.
},
}</pre>
</div>
</body></html>
|
