## 通用類型 - [Locality](#locality) - [Node](#node) - [Endpoint](#endpoint) - [Metadata](#metadata) - [RuntimeUInt32](#runtimeuint32) - [HeaderValue](#headervalue) - [HeaderValueOption](#headervalueoption) - [ApiConfigSource](#apiconfigsource) - [ApiConfigSource.ApiType (Enum)](#apiconfigsourceapitype-enum) - [AggregatedConfigSource](#aggregatedconfigsource) - [ConfigSource](#configsource) - [TransportSocket](#transportsocket) - [RoutingPriority (Enum)](#routingpriority-enum) - [RequestMethod (Enum)](#requestmethod-enum) ### Locality [Locality proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L16) 標識Envoy運行所在的位置或上游主機運行所在的位置。 ``` { "region": "...", "zone": "...", "sub_zone": "..." } ``` - **region**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 當前屬于哪個區域 - **zone**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) AWS上的可用區域（AZ），GCP區域等 - **sub_zone**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 當用于上游主機的位置時，該字段進一步將區域分成更小的子區域，從而可以獨立地進行負載平衡。 ### Node [Node proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L35) 標識特定的Envoy實例。節點標識符將呈現給管理服務器，管理服務器可以使用該標識符來區分每個Envoy服務的配置。 ``` { "id": "...", "cluster": "...", "metadata": "{...}", "locality": "{...}", "build_version": "..." } ``` - **id**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) Envoy節點的標識符。 - **cluster**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) Envoy節點所屬的群集。 - **metadata**<br /> ([Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)) 所在節點的擴展元數據，Envoy將直接傳遞給管理服務器。 - **locality**<br /> ([Locality](#locality)) 指定Envoy實例的運行位置。 - **build_version**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 在金絲雀（灰度發布）期間管理服務器，知道哪個版本的Envoy正在進行測試。這將由Envoy在管理服務器RPC中設置。 ### Endpoint [Endpoint proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L35) 上游主機標識符 ``` { "address": "{...}" } ``` - **address**<br /> ([Address](Networkaddresses.md)) ### Metadata [Metadata proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L74) 元數據用于監聽器的匹配場景，為路由、端口、過濾器鏈等提供了額外的輸入。它的結構是從過濾器名稱（反向DNS格式）到特定的過濾器元數據的映射。過濾器的元數據key/value將合并在連接并發生請求時處理，同一個key的更新值將覆蓋舊值。 元數據的使用示例，在HTTP連接管理追加附加信息，將體現在`envoy.http_connection_manager.access_log`命名空間。 為了實現負載平衡，元數據提供了一種集群端口子集的方法。端口匹配關聯的元數據對象，路由匹配關聯的元數據對象。當前有一些定義的元數據用于此目的： - `{"envoy.lb": {"canary": <bool> }}` 這表明了一個端口的`canary`狀態，并且用于頭部（x-envoy-upstream-canary）和統計處理。 ``` { "filter_metadata": "{...}" } ``` - **filter_metadata**<br /> (map<string, Struct>) key是反向DNS過濾器名稱，例如`com.acme.widget`。命名空間`envoy.*`保留給Envoy內置過濾器使用。 ### RuntimeUInt32 [RuntimeUInt32 proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L81) 若沒有指定時，則在運行時生成的uint32默認值。 ``` { "default_value": "...", "runtime_key": "..." } ``` - **default_value**<br /> ([uint32](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 默認值，運行時沒有可用的值時。 - **runtime_key**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar), REQUIRED) 運行時，通過key以獲取相應的value。如果定義，則使用此值。 ### HeaderValue [HeaderValue proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L115) Header鍵值對。 ``` { "key": "...", "value": "..." } ``` - **key**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) Header Key. - **value**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) Header Value. HTTP訪問日志記錄的[格式說明符](../Configurationreference/Accesslogging.md)可以在此處應用，但未知的Header值將替換為空字符串而不是`-`。 ### HeaderValueOption [HeaderValueOption proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L128) Header鍵值對追加控制選項。 ``` { "header": "{...}", "append": "{...}" } ``` - **header**<br /> ([HeaderValue](#headervalue)) 控制選項所應用的Header鍵值對。 - **append**<br /> ([BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue)) 是否添加的開關，如果為true（默認值），則該值將附加到現有值。 ### ApiConfigSource [ApiConfigSource proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L139) API配置源。這標識了Envoy將用來獲取xDS的API類型和群集。 ``` { "api_type": "...", "cluster_name": [], "refresh_delay": "{...}" } ``` - **api_type**<br /> ([ApiConfigSource.ApiType](#apiconfigsourceapitype)) API類型。 - **cluster_name**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar), REQUIRED) 可以提供多個群集名稱。如果定義了大于1個集群，如果發生任何類型的故障，則將循環切換。 - **refresh_delay**<br /> ([Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration)) 對于REST API，連續輪詢之間的間隔。 ### ApiConfigSource.ApiType (Enum) [ApiConfigSource.ApiType proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L141) 可以通過REST API或gRPC獲取。 - **REST_LEGACY**<br /> (DEFAULT) REST-JSON對應于傳統v1 API。 - **REST**<br /> REST-JSON v2 API，將使用v2 protos規范的JSON編碼。 - **GRPC**<br /> gRPC v2 API。 ### AggregatedConfigSource [AggregatedConfigSource proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L162) 聚合發現服務（ADS）選項。這目前是空的，但在ConfigSource中設置時可以用來指定要使用ADS。 ``` {} ``` ### ConfigSource [ConfigSource proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L171) 監聽器，集群，路由，端口等配置可以從文件系統或xDS API源獲取。使用`inotify`監視文件系統配置以進行更新。 ``` { "path": "...", "api_config_source": "{...}", "ads": "{...}" } ``` - **path**<br /> ([string](#https://developersgooglecom/protocol-buffers/docs/proto#scalar)) 配置從文件系統路徑來源來更新配置。 - **api_config_source**<br /> ([ApiConfigSource](#apiconfigsource)) API配置源。 - **ads**<br /> ([AggregatedConfigSource](#aggregatedconfigsource)) 配置使用ADS將做為配置源。將使用[引導程序](Bootstrap.md)配置中的ADS API配置源。 注意：必須選擇`path`,`api_config_source`,`ads`其中一個選項配置。 ### TransportSocket [TransportSocket proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L188) 監聽器和集群中傳輸套接字的配置。如果配置為空，則將根據`tls_context`的平臺和現有的來選擇默認的傳輸套接字實現和配置。 ``` { "name": "...", "config": "{...}" } ``` - **name**<br /> ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar), REQUIRED) 要實例化的傳輸套接字的名稱。該名稱必須匹配支持的傳輸套接字實現。 - **config**<br /> ([Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)) 具體將要被實例化的傳輸套接字配置。請參閱[支持的傳輸套接字]()實現以獲取更多信息。 ### RoutingPriority (Enum) [RoutingPriority proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L96) Envoy在路由和虛擬集群級別，都支持上游優先級路由。當前的實現是針對每個優先級別，使用不同的連接池和斷路設置。這意味著即使對于HTTP/2請求，兩個物理連接也將被用于上游主機。將來，Envoy可能會支持真正的HTTP/2優先級，而不是單個上行連接。 - **DEFAULT**<br /> (DEFAULT) - **HIGH** ### RequestMethod (Enum) [RequestMethod proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/base.proto#L102) HTTP請求方法 - **METHOD_UNSPECIFIED**<br /> (DEFAULT) - **GET** - **HEAD** - **POST** - **PUT** - **DELETE** - **CONNECT** - **OPTIONS** - **TRACE** ## 返回 - [上一級](../v2APIreference.md) - [首頁目錄](../README.md)