-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
trafficdirector_v3.discovery.html
551 lines (529 loc) 路 57.4 KB
/
trafficdirector_v3.discovery.html
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
<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="trafficdirector_v3.html">Traffic Director API</a> . <a href="trafficdirector_v3.discovery.html">discovery</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#client_status">client_status(body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="client_status">client_status(body=None, x__xgafv=None)</code>
<pre>
Args:
body: object, The request body.
The object takes the form of:
{ # Request for client status of clients identified by a list of NodeMatchers.
"excludeResourceContents": True or False, # If true, the server will not include the resource contents in the response (i.e., the generic_xds_configs.xds_config field will not be populated). [#not-implemented-hide:]
"node": { # Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 13] # The node making the csds request.
"clientFeatures": [ # Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example ``com.acme.feature``. See :ref:`the list of features ` that xDS client may support.
"A String",
],
"cluster": "A String", # Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:`statsd `, :ref:`health check cluster verification `, :ref:`runtime override directory `, :ref:`user agent addition `, :ref:`HTTP global rate limiting `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-cluster`.
"dynamicParameters": { # Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike other fields in this message). For example, the xDS client may have a shard identifier that changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic parameter then appears in this field during future discovery requests.
"a_key": { # Additional parameters that can be used to select resource variants. These include any global context parameters, per-resource type client feature capabilities and per-resource type functional attributes. All per-resource type attributes will be `xds.resource.` prefixed and some of these are documented below: `xds.resource.listening_address`: The value is "IP:port" (e.g. "10.1.1.3:8080") which is the listening address of a Listener. Used in a Listener resource query.
"params": {
"a_key": "A String",
},
},
},
"extensions": [ # List of extensions and their versions supported by the node.
{ # Version and identification for an Envoy extension. [#next-free-field: 7]
"category": "A String", # Category of the extension. Extension category names use reverse DNS notation. For instance "envoy.filters.listener" for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from acme.com vendor. [#comment:
"disabled": True or False, # Indicates that the extension is present but was disabled via dynamic configuration.
"name": "A String", # This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
"typeDescriptor": "A String", # [#not-implemented-hide:] Type descriptor of extension configuration proto. [#comment:
"typeUrls": [ # Type URLs of extension configuration protos.
"A String",
],
"version": { # BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. # The version is a property of the extension and maintained independently of other extensions and the Envoy API. This field is not set when extension did not provide version information.
"metadata": { # Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file
"a_key": "", # Properties of the object.
},
"version": { # Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored. # SemVer version of extension.
"majorNumber": 42,
"minorNumber": 42,
"patch": 42,
},
},
},
],
"id": "A String", # An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: :ref:`statsd `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-node`.
"listeningAddresses": [ # Known listening ports on the node as a generic hint to the management server for filtering :ref:`listeners ` to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress ``(0.0.0.0,80)``. The field is optional and just a hint.
{ # Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.
"envoyInternalAddress": { # The address represents an envoy internal listener. [#comment: # Specifies a user-space address handled by :ref:`internal listeners `.
"endpointId": "A String", # Specifies an endpoint identifier to distinguish between multiple endpoints for the same internal listener in a single upstream pool. Only used in the upstream addresses for tracking changes to individual endpoints. This, for example, may be set to the final destination IP for the target internal listener.
"serverListenerName": "A String", # Specifies the :ref:`name ` of the internal listener.
},
"pipe": {
"mode": 42, # The mode for the Pipe. Not applicable for abstract sockets.
"path": "A String", # Unix Domain Socket path. On Linux, paths starting with '@' will use the abstract namespace. The starting '@' is replaced by a null byte by Envoy. Paths starting with '@' will result in an error in environments other than Linux.
},
"socketAddress": { # [#next-free-field: 7]
"address": "A String", # The address for this socket. :ref:`Listeners ` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig `, the address controls the source address of outbound connections. For :ref:`clusters `, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name `.
"ipv4Compat": True or False, # When binding to an IPv6 address above, this enables `IPv4 compatibility `_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``.
"namedPort": "A String", # This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution.
"portValue": 42,
"protocol": "A String",
"resolverName": "A String", # The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime.
},
},
],
"locality": { # Identifies location of where either Envoy runs or where upstream hosts run. # Locality specifying where the Envoy instance is running.
"region": "A String", # Region this :ref:`zone ` belongs to.
"subZone": "A String", # When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.
"zone": "A String", # Defines the local service zone where Envoy is running. Though optional, it should be set if discovery service routing is used and the discovery service exposes :ref:`zone data `, either in this message or via :option:`--service-zone`. The meaning of zone is context dependent, e.g. `Availability Zone (AZ) `_ on AWS, `Zone `_ on GCP, etc.
},
"metadata": { # Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.
"a_key": "", # Properties of the object.
},
"userAgentBuildVersion": { # BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. # Structured version of the entity requesting config.
"metadata": { # Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file
"a_key": "", # Properties of the object.
},
"version": { # Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored. # SemVer version of extension.
"majorNumber": 42,
"minorNumber": 42,
"patch": 42,
},
},
"userAgentName": "A String", # Free-form string that identifies the entity requesting config. E.g. "envoy" or "grpc"
"userAgentVersion": "A String", # Free-form string that identifies the version of the entity requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
},
"nodeMatchers": [ # Management server can use these match criteria to identify clients. The match follows OR semantics.
{ # Specifies the way to match a Node. The match follows AND semantics.
"nodeId": { # Specifies the way to match a string. [#next-free-field: 9] # Specifies match criteria on the node id.
"contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
"custom": { # Message type for extension configuration. # Use an extension as the matcher type. [#extension-category: envoy.string_matcher]
"name": "A String", # The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier.
"typedConfig": { # The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview ` for further details.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
"ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. This has no effect for the safe_regex match. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
"prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
"safeRegex": { # A regex matcher designed for safety when used with untrusted input. # The input string must match the regular expression specified here.
"googleRe2": { # Google's `RE2 `_ regex engine. The regex string must adhere to the documented `syntax `_. The engine is designed to complete execution in linear time as well as limit the amount of memory used. Envoy supports program size checking via runtime. The runtime keys ``re2.max_program_size.error_level`` and ``re2.max_program_size.warn_level`` can be set to integers as the maximum program size or complexity that a compiled regex can have before an exception is thrown or a warning is logged, respectively. ``re2.max_program_size.error_level`` defaults to 100, and ``re2.max_program_size.warn_level`` has no default if unset (will not check/log a warning). Envoy emits two stats for tracking the program size of regexes: the histogram ``re2.program_size``, which records the program size, and the counter ``re2.exceeded_warn_level``, which is incremented each time the program size exceeds the warn level threshold. # Google's RE2 regex engine.
"maxProgramSize": 42, # This field controls the RE2 "program size" which is a rough estimate of how complex a compiled regex is to evaluate. A regex that has a program size greater than the configured value will fail to compile. In this case, the configured max program size can be increased or the regex can be simplified. If not specified, the default is 100. This field is deprecated; regexp validation should be performed on the management server instead of being done by each individual client. .. note:: Although this field is deprecated, the program size will still be checked against the global ``re2.max_program_size.error_level`` runtime value.
},
"regex": "A String", # The regex match string. The string must be supported by the configured engine. The regex is matched against the full string, not as a partial match.
},
"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
},
"nodeMetadatas": [ # Specifies match criteria on the node metadata.
{ # StructMatcher provides a general interface to check if a given value is matched in google.protobuf.Struct. It uses ``path`` to retrieve the value from the struct and then check if it's matched to the specified value. For example, for the following Struct: .. code-block:: yaml fields: a: struct_value: fields: b: struct_value: fields: c: string_value: pro t: list_value: values: - string_value: m - string_value: n The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value "pro" from the Metadata which is matched to the specified prefix match. .. code-block:: yaml path: - key: a - key: b - key: c value: string_match: prefix: pr The following StructMatcher is matched as the code will match one of the string values in the list at the path [a, t]. .. code-block:: yaml path: - key: a - key: t value: list_match: one_of: string_match: exact: m An example use of StructMatcher is to match metadata in envoy.v*.core.Node.
"path": [ # The path to retrieve the Value from the Struct.
{ # Specifies the segment in a path to retrieve value from Struct.
"key": "A String", # If specified, use the key to retrieve the value in a Struct.
},
],
"value": { # Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8] # The StructMatcher is matched if the value retrieved by path is matched to this value.
"boolMatch": True or False, # If specified, a match occurs if and only if the target value is a bool value and is equal to this field.
"doubleMatch": { # Specifies the way to match a double value. # If specified, a match occurs if and only if the target value is a double value and is matched to this field.
"exact": 3.14, # If specified, the input double value must be equal to the value specified here.
"range": { # Specifies the double start and end of the range using half-open interval semantics [start, end). # If specified, the input double value must be in the range specified here. Note: The range is using half-open interval semantics [start, end).
"end": 3.14, # end of the range (exclusive)
"start": 3.14, # start of the range (inclusive)
},
},
"listMatch": { # Specifies the way to match a list value. # If specified, a match occurs if and only if the target value is a list value and is matched to this field.
"oneOf": # Object with schema name: ValueMatcher # If specified, at least one of the values in the list must match the value specified.
},
"nullMatch": { # NullMatch is an empty message to specify a null value. # If specified, a match occurs if and only if the target value is a NullValue.
},
"orMatch": { # Specifies a list of alternatives for the match. # If specified, a match occurs if and only if any of the alternatives in the match accept the value.
"valueMatchers": [
# Object with schema name: ValueMatcher
],
},
"presentMatch": True or False, # If specified, value match will be performed based on whether the path is referring to a valid primitive value in the metadata. If the path is referring to a non-primitive value, the result is always not matched.
"stringMatch": { # Specifies the way to match a string. [#next-free-field: 9] # If specified, a match occurs if and only if the target value is a string value and is matched to this field.
"contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
"custom": { # Message type for extension configuration. # Use an extension as the matcher type. [#extension-category: envoy.string_matcher]
"name": "A String", # The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier.
"typedConfig": { # The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview ` for further details.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
"ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. This has no effect for the safe_regex match. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
"prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
"safeRegex": { # A regex matcher designed for safety when used with untrusted input. # The input string must match the regular expression specified here.
"googleRe2": { # Google's `RE2 `_ regex engine. The regex string must adhere to the documented `syntax `_. The engine is designed to complete execution in linear time as well as limit the amount of memory used. Envoy supports program size checking via runtime. The runtime keys ``re2.max_program_size.error_level`` and ``re2.max_program_size.warn_level`` can be set to integers as the maximum program size or complexity that a compiled regex can have before an exception is thrown or a warning is logged, respectively. ``re2.max_program_size.error_level`` defaults to 100, and ``re2.max_program_size.warn_level`` has no default if unset (will not check/log a warning). Envoy emits two stats for tracking the program size of regexes: the histogram ``re2.program_size``, which records the program size, and the counter ``re2.exceeded_warn_level``, which is incremented each time the program size exceeds the warn level threshold. # Google's RE2 regex engine.
"maxProgramSize": 42, # This field controls the RE2 "program size" which is a rough estimate of how complex a compiled regex is to evaluate. A regex that has a program size greater than the configured value will fail to compile. In this case, the configured max program size can be increased or the regex can be simplified. If not specified, the default is 100. This field is deprecated; regexp validation should be performed on the management server instead of being done by each individual client. .. note:: Although this field is deprecated, the program size will still be checked against the global ``re2.max_program_size.error_level`` runtime value.
},
"regex": "A String", # The regex match string. The string must be supported by the configured engine. The regex is matched against the full string, not as a partial match.
},
"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
},
},
},
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"config": [ # Client configs for the clients specified in the ClientStatusRequest.
{ # All xds configs for a particular client.
"clientScope": "A String", # For xDS clients, the scope in which the data is used. For example, gRPC indicates the data plane target or that the data is associated with gRPC server(s).
"genericXdsConfigs": [ # Represents generic xDS config and the exact config structure depends on the type URL (like Cluster if it is CDS)
{ # GenericXdsConfig is used to specify the config status and the dump of any xDS resource identified by their type URL. It is the generalized version of the now deprecated ListenersConfigDump, ClustersConfigDump etc [#next-free-field: 10]
"clientStatus": "A String", # Per xDS resource status from the view of a xDS client
"configStatus": "A String", # Per xDS resource config status. It is generated by management servers. It will not be present if the CSDS server is an xDS client.
"errorState": { # Set if the last update failed, cleared after the next successful update. The *error_state* field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"isStaticResource": True or False, # Is static resource is true if it is specified in the config supplied through the file at the startup.
"lastUpdated": "A String", # Timestamp when the xDS resource was last updated
"name": "A String", # Name of the xDS resource
"typeUrl": "A String", # Type_url represents the fully qualified name of xDS resource type like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc.
"versionInfo": "A String", # This is the :ref:`version_info ` in the last processed xDS discovery response. If there are only static bootstrap listeners, this field will be ""
"xdsConfig": { # The xDS resource config. Actual content depends on the type
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
],
"node": { # Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 13] # Node for a particular client.
"clientFeatures": [ # Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example ``com.acme.feature``. See :ref:`the list of features ` that xDS client may support.
"A String",
],
"cluster": "A String", # Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:`statsd `, :ref:`health check cluster verification `, :ref:`runtime override directory `, :ref:`user agent addition `, :ref:`HTTP global rate limiting `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-cluster`.
"dynamicParameters": { # Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike other fields in this message). For example, the xDS client may have a shard identifier that changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic parameter then appears in this field during future discovery requests.
"a_key": { # Additional parameters that can be used to select resource variants. These include any global context parameters, per-resource type client feature capabilities and per-resource type functional attributes. All per-resource type attributes will be `xds.resource.` prefixed and some of these are documented below: `xds.resource.listening_address`: The value is "IP:port" (e.g. "10.1.1.3:8080") which is the listening address of a Listener. Used in a Listener resource query.
"params": {
"a_key": "A String",
},
},
},
"extensions": [ # List of extensions and their versions supported by the node.
{ # Version and identification for an Envoy extension. [#next-free-field: 7]
"category": "A String", # Category of the extension. Extension category names use reverse DNS notation. For instance "envoy.filters.listener" for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from acme.com vendor. [#comment:
"disabled": True or False, # Indicates that the extension is present but was disabled via dynamic configuration.
"name": "A String", # This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
"typeDescriptor": "A String", # [#not-implemented-hide:] Type descriptor of extension configuration proto. [#comment:
"typeUrls": [ # Type URLs of extension configuration protos.
"A String",
],
"version": { # BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. # The version is a property of the extension and maintained independently of other extensions and the Envoy API. This field is not set when extension did not provide version information.
"metadata": { # Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file
"a_key": "", # Properties of the object.
},
"version": { # Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored. # SemVer version of extension.
"majorNumber": 42,
"minorNumber": 42,
"patch": 42,
},
},
},
],
"id": "A String", # An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: :ref:`statsd `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-node`.
"listeningAddresses": [ # Known listening ports on the node as a generic hint to the management server for filtering :ref:`listeners ` to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress ``(0.0.0.0,80)``. The field is optional and just a hint.
{ # Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.
"envoyInternalAddress": { # The address represents an envoy internal listener. [#comment: # Specifies a user-space address handled by :ref:`internal listeners `.
"endpointId": "A String", # Specifies an endpoint identifier to distinguish between multiple endpoints for the same internal listener in a single upstream pool. Only used in the upstream addresses for tracking changes to individual endpoints. This, for example, may be set to the final destination IP for the target internal listener.
"serverListenerName": "A String", # Specifies the :ref:`name ` of the internal listener.
},
"pipe": {
"mode": 42, # The mode for the Pipe. Not applicable for abstract sockets.
"path": "A String", # Unix Domain Socket path. On Linux, paths starting with '@' will use the abstract namespace. The starting '@' is replaced by a null byte by Envoy. Paths starting with '@' will result in an error in environments other than Linux.
},
"socketAddress": { # [#next-free-field: 7]
"address": "A String", # The address for this socket. :ref:`Listeners ` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig `, the address controls the source address of outbound connections. For :ref:`clusters `, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name `.
"ipv4Compat": True or False, # When binding to an IPv6 address above, this enables `IPv4 compatibility `_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``.
"namedPort": "A String", # This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution.
"portValue": 42,
"protocol": "A String",
"resolverName": "A String", # The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime.
},
},
],
"locality": { # Identifies location of where either Envoy runs or where upstream hosts run. # Locality specifying where the Envoy instance is running.
"region": "A String", # Region this :ref:`zone ` belongs to.
"subZone": "A String", # When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.
"zone": "A String", # Defines the local service zone where Envoy is running. Though optional, it should be set if discovery service routing is used and the discovery service exposes :ref:`zone data `, either in this message or via :option:`--service-zone`. The meaning of zone is context dependent, e.g. `Availability Zone (AZ) `_ on AWS, `Zone `_ on GCP, etc.
},
"metadata": { # Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.
"a_key": "", # Properties of the object.
},
"userAgentBuildVersion": { # BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. # Structured version of the entity requesting config.
"metadata": { # Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file
"a_key": "", # Properties of the object.
},
"version": { # Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored. # SemVer version of extension.
"majorNumber": 42,
"minorNumber": 42,
"patch": 42,
},
},
"userAgentName": "A String", # Free-form string that identifies the entity requesting config. E.g. "envoy" or "grpc"
"userAgentVersion": "A String", # Free-form string that identifies the version of the entity requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
},
"xdsConfig": [ # This field is deprecated in favor of generic_xds_configs which is much simpler and uniform in structure.
{ # Detailed config (per xDS) with status. [#next-free-field: 8]
"clientStatus": "A String", # Client config status is populated by xDS clients. Will not be present if the CSDS server is an xDS server. No matter what the client config status is, xDS clients should always dump the most recent accepted xDS config. .. attention:: This field is deprecated. Use :ref:`ClientResourceStatus ` for per-resource config status instead.
"clusterConfig": { # Envoy's cluster manager fills this message with all currently known clusters. Cluster configuration information can be used to recreate an Envoy configuration by populating all clusters as static clusters or by returning them in a CDS response.
"dynamicActiveClusters": [ # The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.
{ # Describes a dynamically loaded cluster via the CDS API. [#next-free-field: 6]
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"cluster": { # The cluster config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"lastUpdated": "A String", # The timestamp when the Cluster was last updated.
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the cluster was loaded. In the future, discrete per-cluster versions may be supported by the API.
},
],
"dynamicWarmingClusters": [ # The dynamically loaded warming clusters. These are clusters that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming clusters should generally be discarded.
{ # Describes a dynamically loaded cluster via the CDS API. [#next-free-field: 6]
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"cluster": { # The cluster config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"lastUpdated": "A String", # The timestamp when the Cluster was last updated.
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the cluster was loaded. In the future, discrete per-cluster versions may be supported by the API.
},
],
"staticClusters": [ # The statically loaded cluster configs.
{ # Describes a statically loaded cluster.
"cluster": { # The cluster config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdated": "A String", # The timestamp when the Cluster was last updated.
},
],
"versionInfo": "A String", # This is the :ref:`version_info ` in the last processed CDS discovery response. If there are only static bootstrap clusters, this field will be "".
},
"endpointConfig": { # Envoy's admin fill this message with all currently known endpoints. Endpoint configuration information can be used to recreate an Envoy configuration by populating all endpoints as static endpoints or by returning them in an EDS response.
"dynamicEndpointConfigs": [ # The dynamically loaded endpoint configs.
{ # [#next-free-field: 6]
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"endpointConfig": { # The endpoint config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"lastUpdated": "A String", # [#not-implemented-hide:] The timestamp when the Endpoint was last updated.
"versionInfo": "A String", # [#not-implemented-hide:] This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the endpoint configuration was loaded.
},
],
"staticEndpointConfigs": [ # The statically loaded endpoint configs.
{
"endpointConfig": { # The endpoint config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdated": "A String", # [#not-implemented-hide:] The timestamp when the Endpoint was last updated.
},
],
},
"listenerConfig": { # Envoy's listener manager fills this message with all currently known listeners. Listener configuration information can be used to recreate an Envoy configuration by populating all listeners as static listeners or by returning them in a LDS response.
"dynamicListeners": [ # State for any warming, active, or draining listeners.
{ # Describes a dynamically loaded listener via the LDS API. [#next-free-field: 7]
"activeState": { # The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.
"lastUpdated": "A String", # The timestamp when the Listener was last successfully updated.
"listener": { # The listener config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.
},
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"drainingState": { # The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.
"lastUpdated": "A String", # The timestamp when the Listener was last successfully updated.
"listener": { # The listener config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.
},
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty.
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"name": "A String", # The name or unique id of this listener, pulled from the DynamicListenerState config.
"warmingState": { # The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.
"lastUpdated": "A String", # The timestamp when the Listener was last successfully updated.
"listener": { # The listener config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.
},
},
],
"staticListeners": [ # The statically loaded listener configs.
{ # Describes a statically loaded listener.
"lastUpdated": "A String", # The timestamp when the Listener was last successfully updated.
"listener": { # The listener config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
],
"versionInfo": "A String", # This is the :ref:`version_info ` in the last processed LDS discovery response. If there are only static bootstrap listeners, this field will be "".
},
"routeConfig": { # Envoy's RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes that are either defined in the bootstrap configuration or defined inline while configuring listeners are separated from those configured dynamically via RDS. Route configuration information can be used to recreate an Envoy configuration by populating all routes as static routes or by returning them in RDS responses.
"dynamicRouteConfigs": [ # The dynamically loaded route configs.
{ # [#next-free-field: 6]
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"lastUpdated": "A String", # The timestamp when the Route was last updated.
"routeConfig": { # The route config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the route configuration was loaded.
},
],
"staticRouteConfigs": [ # The statically loaded route configs.
{
"lastUpdated": "A String", # The timestamp when the Route was last updated.
"routeConfig": { # The route config.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
],
},
"scopedRouteConfig": { # Envoy's scoped RDS implementation fills this message with all currently loaded route configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the dynamically obtained scopes via the SRDS API.
"dynamicScopedRouteConfigs": [ # The dynamically loaded scoped route configs.
{ # [#next-free-field: 7]
"clientStatus": "A String", # The client status of this resource. [#not-implemented-hide:]
"errorState": { # Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
"versionInfo": "A String", # This is the version of the rejected resource. [#not-implemented-hide:]
},
"lastUpdated": "A String", # The timestamp when the scoped route config set was last updated.
"name": "A String", # The name assigned to the scoped route configurations.
"scopedRouteConfigs": [ # The scoped route configurations.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"versionInfo": "A String", # This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the scoped routes configuration was loaded.
},
],
"inlineScopedRouteConfigs": [ # The statically loaded scoped route configs.
{
"lastUpdated": "A String", # The timestamp when the scoped route config set was last updated.
"name": "A String", # The name assigned to the scoped route configurations.
"scopedRouteConfigs": [ # The scoped route configurations.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
],
},
"status": "A String", # Config status generated by management servers. Will not be present if the CSDS server is an xDS client.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
</body></html>