Request Service
Protobuf Definition#
service RequestService { rpc GetLsNodes(TopologyRequest) returns (LsNodeResponse) {} rpc GetLsLinks(TopologyRequest) returns (LsLinkResponse) {} rpc GetLsPrefixes(TopologyRequest) returns (LsPrefixResponse) {} rpc GetLsSrv6Sids(TopologyRequest) returns (LsSrv6SidResponse) {} rpc GetLsNodeEdges(TopologyRequest) returns (LsNodeEdgeResponse) {} rpc GetTelemetryData(TelemetryRequest) returns (TelemetryResponse) {}}Methods#
GetLsNodes()#
rpc GetLsNodes(TopologyRequest) returns (LsNodeResponse) {}See also: TopologyRequest, LsNodeResponse
Description#
Takes a TopologyRequest with the specified keys and properties and returns an LsNodeResponse containing all requested LsNodes with the requested properties.
- Omitting keys returns all available LsNodes.
- Omitting properties returns LsNodes with all available properties.
Examples#
| keys | properties | LsNodeResponse |
|---|---|---|
| [ "nodeKey1", "nodeKey2" ] | [ "Name", "Asn", "RouterIp" ] | LsNodeResponse contains LsNodes for the two specified keys with the three requested properties. |
| - | [ "Name", "Asn", "RouterIp" ] | LsNodeResponse contains all available LsNodes with the three requested properties. |
| [ "nodeKey1", "nodeKey2" ] | - | LsNodeResponse contains LsNodes for the two specified keys with all available properties. |
| - | - | LsNodeResponse contains all available LsNodes with all available properties. |
GetLsLinks()#
rpc GetLsLinks(TopologyRequest) returns (LsLinkResponse) {}See also: TopologyRequest, LsLinkResponse
Description#
See method GetLsNodes(). It follows the same principle regarding keys and properties.
GetLsPrefixes()#
rpc GetLsPrefixes(TopologyRequest) returns (LsPrefixResponse) {}See also: TopologyRequest, LsPrefixResponse
Description#
See method GetLsNodes(). It follows the same principle regarding keys and properties.
GetLsSrv6Sids()#
rpc GetLsSrv6Sids(TopologyRequest) returns (LsSrv6SidResponse) {}See also: TopologyRequest, LsSrv6SidResponse
Description#
See method GetLsNodes(). It follows the same principle regarding keys and properties.
GetLsNodeEdges()#
rpc GetLsNodeEdges(TopologyRequest) returns (LsNodeEdgeResponse) {}See also: TopologyRequest, LsNodeEdgeResponse
Description#
See method GetLsNodes(). It follows the same principle regarding keys and properties.
GetTelemetryData()#
rpc GetTelemetryData(TelemetryRequest) returns (TelemetryResponse) {}See also: TelemetryRequest, TelemetryResponse
Description#
Takes a TelemetryRequest with the specified ipv4addresses and properties and returns an TelemetryResponse containing TelemetryData objects (one for each ipv4address) and all requested properties.
- Omitting ipv4addresses returns an empty TelemetryResponse.
- Omitting properties returns TelemetryData with all available properties.
Examples#
| ipv4addresses | properties | TelemetryResponse |
|---|---|---|
| [ "1.2.3.4", "2.3.4.5" ] | [ "DataRate", "PacketsSent", "PacketsReceived" ] | TelemetryResponse contains TelemetryData for the two specified ipv4addresses with the three requested properties. |
| - | [ "DataRate", "PacketsSent", "PacketsReceived" ] | TelemetryResponse contains no TelemetryData! |
| [ "1.2.3.4", "2.3.4.5" ] | - | TelemetryResponse contains TelemetryData for the two specified ipv4addresses with all available properties. |
| - | - | TelemetryResponse contains no TelemetryData! |