Skip to content
Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesTrafficControlServiceView on canton-network-docs
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesTrafficControlService

TrafficControlState

Participant AdministrationProtobufcom.digitalasset.canton.admin.participant.v30TrafficControlState

com.digitalasset.canton.admin.participant.v30

TrafficControlState

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState

Protocol Details

Inputs

TrafficControlStateRequest

synchronizer_idstring

Outputs

TrafficControlStateResponse

traffic_stateTrafficState

Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest

synchronizer_idstring

com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse

traffic_stateTrafficState

com.digitalasset.canton.admin.participant.v30.TrafficState

extra_traffic_purchasedint64
extra_traffic_consumedint64
base_traffic_remainderint64
last_consumed_costuint64
timestampint64
serialuint32
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState <<'EOF'
{
  "synchronizerId": "string"
}
EOF
OKapplication/json
OK
{
  "trafficState": {
    "extraTrafficPurchased": "0",
    "extraTrafficConsumed": "0",
    "baseTrafficRemainder": "0",
    "lastConsumedCost": "0",
    "timestamp": "0",
    "serial": 0
  }
}