[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation. (grpc依赖)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

100 lines
2.9 KiB

syntax = "proto3";
package envoy.service.status.v3;
import "envoy/admin/v3/config_dump.proto";
import "envoy/config/core/v3/base.proto";
import "envoy/type/matcher/v3/node.proto";
import "google/api/annotations.proto";
import "google/protobuf/struct.proto";
import "udpa/annotations/versioning.proto";
option java_package = "io.envoyproxy.envoy.service.status.v3";
option java_outer_classname = "CsdsProto";
option java_multiple_files = true;
option java_generic_services = true;
// [#protodoc-title: Client Status Discovery Service (CSDS)]
// CSDS is Client Status Discovery Service. It can be used to get the status of
// an xDS-compliant client from the management server's point of view. In the
// future, it can potentially be used as an interface to get the current
// state directly from the client.
service ClientStatusDiscoveryService {
rpc StreamClientStatus(stream ClientStatusRequest) returns (stream ClientStatusResponse) {
}
rpc FetchClientStatus(ClientStatusRequest) returns (ClientStatusResponse) {
option (google.api.http).post = "/v3/discovery:client_status";
option (google.api.http).body = "*";
}
}
// Status of a config.
enum ConfigStatus {
// Status info is not available/unknown.
UNKNOWN = 0;
// Management server has sent the config to client and received ACK.
SYNCED = 1;
// Config is not sent.
NOT_SENT = 2;
// Management server has sent the config to client but hasn’t received
// ACK/NACK.
STALE = 3;
// Management server has sent the config to client but received NACK.
ERROR = 4;
}
// Request for client status of clients identified by a list of NodeMatchers.
message ClientStatusRequest {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.status.v2.ClientStatusRequest";
// Management server can use these match criteria to identify clients.
// The match follows OR semantics.
repeated type.matcher.v3.NodeMatcher node_matchers = 1;
}
// Detailed config (per xDS) with status.
// [#next-free-field: 6]
message PerXdsConfig {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.status.v2.PerXdsConfig";
ConfigStatus status = 1;
oneof per_xds_config {
admin.v3.ListenersConfigDump listener_config = 2;
admin.v3.ClustersConfigDump cluster_config = 3;
admin.v3.RoutesConfigDump route_config = 4;
admin.v3.ScopedRoutesConfigDump scoped_route_config = 5;
}
}
// All xds configs for a particular client.
message ClientConfig {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.status.v2.ClientConfig";
// Node for a particular client.
config.core.v3.Node node = 1;
repeated PerXdsConfig xds_config = 2;
}
message ClientStatusResponse {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.status.v2.ClientStatusResponse";
// Client configs for the clients specified in the ClientStatusRequest.
repeated ClientConfig config = 1;
}