client_status(body=None, x__xgafv=None)

Args:
body: object, The request body.
The object takes the form of:

{ # Request for client status of clients identified by a list of NodeMatchers.
"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: 7] # Specifies match criteria on the node id.
"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 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*
"regex": "A String", # The input string must match the regular expression specified here. The regex grammar is defined `here `_. Examples: * The regex ``\d{3}`` matches the value *123* * The regex ``\d{3}`` does not match the value *1234* * The regex ``\d{3}`` does not match the value *123.456* .. attention:: This field has been deprecated in favor of `safe_regex` as it is not safe for use with untrusted input in all cases.
"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.
},
"regex": "A String", # The regex match string. The string must be supported by the configured engine.
},
"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: 7] # 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.
},
"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: 7] # If specified, a match occurs if and only if the target value is a string value and is matched to this field.
"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 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*
"regex": "A String", # The input string must match the regular expression specified here. The regex grammar is defined `here `_. Examples: * The regex ``\d{3}`` matches the value *123* * The regex ``\d{3}`` does not match the value *1234* * The regex ``\d{3}`` does not match the value *123.456* .. attention:: This field has been deprecated in favor of `safe_regex` as it is not safe for use with untrusted input in all cases.
"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.
},
"regex": "A String", # The regex match string. The string must be supported by the configured engine.
},
"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.
"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: 12] # Node for a particular client.
"buildVersion": "A String", # This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet. This will be set by Envoy in management server RPCs. This field is deprecated in favor of the user_agent_name and user_agent_version values.
"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`.
"extensions": [ # List of extensions and their versions supported by the node.
{ # Version and identification for an Envoy extension. [#next-free-field: 6]
"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:
"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.
"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": [
{ # Detailed config (per xDS) with status. [#next-free-field: 6]
"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.
"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 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.
"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 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 "".
},
"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: 6]
"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.
},
"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.
"details": "A String", # Details about the last failed update attempt.
"failedConfiguration": { # What the component configuration would have been if the update had succeeded.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"lastUpdateAttempt": "A String", # Time of the latest failed update attempt.
},
"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.
{
"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.
{
"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",
},
],
},
],
}

Traffic Director API . discovery

Instance Methods

Method Details