--- title: "POST /v3/discovery:client_status" method: POST path: "/v3/discovery:client_status" tags: ["discovery"] --- # POST /v3/discovery:client_status `POST /v3/discovery:client_status` ## Request body - ClientStatusRequest — Request for client status of clients identified by a list of NodeMatchers. - `nodeMatchers` NodeMatcher[] — Management server can use these match criteria to identify clients. The match follows OR semantics. - `nodeId` StringMatcher — Specifies the way to match a string. [#next-free-field: 9] - `exact` string — The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. - `prefix` string — The input string must have the prefix specified here. .. note:: Empty prefix match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``abc.xyz`` - `custom` TypedExtensionConfig — Message type for extension configuration. - `name` string — The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier. - `typedConfig` object — 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. - `safeRegex` RegexMatcher — A regex matcher designed for safety when used with untrusted input. - `googleRe2` 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. - `maxProgramSize` integer — 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` 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. - `contains` string — The input string must have the substring specified here. .. note:: Empty contains match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` - `ignoreCase` boolean — 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 this option is set to ``true``. - `suffix` string — The input string must have the suffix specified here. .. note:: Empty suffix match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``xyz.abc`` - `nodeMetadatas` StructMatcher[] — Specifies match criteria on the node metadata. - `value` ValueMatcher — Specifies the way to match a Protobuf::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8] - `doubleMatch` DoubleMatcher — Specifies the way to match a double value. - `exact` number, double — If specified, the input double value must be equal to the value specified here. - `range` DoubleRange — Specifies the double start and end of the range using half-open interval semantics [start, end). - `start` number, double — start of the range (inclusive) - `end` number, double — end of the range (exclusive) - `listMatch` ListMatcher — Specifies the way to match a list value. - `oneOf` ValueMatcher — recursive - `presentMatch` boolean — 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. - `orMatch` OrMatcher — Specifies a list of alternatives for the match. - `valueMatchers` ValueMatcher[] - `nullMatch` NullMatch — NullMatch is an empty message to specify a null value. - `stringMatch` StringMatcher — Specifies the way to match a string. [#next-free-field: 9] - `exact` string — The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. - `prefix` string — The input string must have the prefix specified here. .. note:: Empty prefix match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``abc.xyz`` - `custom` TypedExtensionConfig — Message type for extension configuration. - `name` string — The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier. - `typedConfig` object — 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. - `safeRegex` RegexMatcher — A regex matcher designed for safety when used with untrusted input. - `googleRe2` 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. - … - `regex` 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. - `contains` string — The input string must have the substring specified here. .. note:: Empty contains match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` - `ignoreCase` boolean — 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 this option is set to ``true``. - `suffix` string — The input string must have the suffix specified here. .. note:: Empty suffix match is not allowed, please use ``safe_regex`` instead. Examples: * ``abc`` matches the value ``xyz.abc`` - `boolMatch` boolean — If specified, a match occurs if and only if the target value is a bool value and is equal to this field. - `path` PathSegment[] — The path to retrieve the Value from the Struct. - `key` string — If specified, use the key to retrieve the value in a Struct. - `node` 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] - `id` 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`. - `userAgentName` string — Free-form string that identifies the entity requesting config. E.g. "envoy" or "grpc" - `userAgentVersion` string — Free-form string that identifies the version of the entity requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild" - `cluster` 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`. - `clientFeatures` string[] — 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. - `extensions` Extension[] — List of extensions and their versions supported by the node. - `disabled` boolean — Indicates that the extension is present but was disabled via dynamic configuration. - `version` BuildVersion — BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. - `version` SemanticVersion — 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. - `majorNumber` integer - `minorNumber` integer - `patch` integer - `metadata` object — Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file - `name` string — This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget. - `category` 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: - `typeDescriptor` string — [#not-implemented-hide:] Type descriptor of extension configuration proto. [#comment: - `typeUrls` string[] — Type URLs of extension configuration protos. - `userAgentBuildVersion` BuildVersion — BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings. - `version` SemanticVersion — 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. - `majorNumber` integer - `minorNumber` integer - `patch` integer - `metadata` object — Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file - `dynamicParameters` object — 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. - `listeningAddresses` Address[] — 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. - `socketAddress` SocketAddress — [#next-free-field: 8] - `resolverName` 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. - `networkNamespaceFilepath` string — Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. - `portValue` integer - `ipv4Compat` boolean — 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:``. - `address` 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 `. - `namedPort` string — This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution. - `protocol` 'TCP' | 'UDP' - `pipe` Pipe - `path` 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. - `mode` integer — The mode for the Pipe. Not applicable for abstract sockets. - `envoyInternalAddress` EnvoyInternalAddress — The address represents an envoy internal listener. [#comment: - `endpointId` 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` string — Specifies the :ref:`name ` of the internal listener. - `metadata` object — Opaque metadata extending the node identifier. Envoy will pass this directly to the management server. - `locality` Locality — Identifies location of where either Envoy runs or where upstream hosts run. - `zone` 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. - `region` string — Region this :ref:`zone ` belongs to. - `subZone` 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. - `excludeResourceContents` boolean — 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:] ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/trafficdirector.md) · [All operations](https://skmtc.dev/google/apis/trafficdirector/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/trafficdirector/revisions/d9ce0c9653a5/schema)