Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.sequencer.v30ServicesSequencerStatusServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.sequencer.v30ServicesSequencerStatusService

SequencerStatus

Sequencer›Protobuf›com.digitalasset.canton.admin.sequencer.v30›SequencerStatus

com.digitalasset.canton.admin.sequencer.v30

​
SequencerStatus

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus

​
Protocol Details

​
Inputs

​
SequencerStatusRequest

​
Outputs

​
SequencerStatusResponse

statusSequencerStatusResponseStatus
not_initializedNotInitialized

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse

statusSequencerStatusResponseStatus
not_initializedNotInitialized

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedParticipant

uidstring

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedMediator

uidstring

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.SequencerStatusResponseStatus

common_statusStatus
connected_participantsrepeated ConnectedParticipant
connected_mediatorsrepeated ConnectedMediator
sequencerSequencerHealthStatus
physical_synchronizer_idstring
adminSequencerAdminStatus
protocol_versionint32

com.digitalasset.canton.admin.health.v30.Status

uidstring
uptimeDuration
portsrepeated map
activebool
topology_queuesTopologyQueueStatus
componentsrepeated ComponentStatus
versionstring

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

manageruint32
dispatcheruint32
clientsuint32

com.digitalasset.canton.admin.health.v30.ComponentStatus

namestring
okStatusData
degradedStatusData
failedStatusData
fatalStatusData

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

descriptionstring

com.digitalasset.canton.admin.sequencer.v30.SequencerHealthStatus

activebool
detailsstring

com.digitalasset.canton.admin.sequencer.v30.SequencerAdminStatus

accepts_admin_changesbool

com.digitalasset.canton.admin.health.v30.NotInitialized

activebool
waiting_for_external_inputWaitingForExternalInput
versionstring

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
  • WAITING_FOR_EXTERNAL_INPUT_ID
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus <<'EOF'
{}
EOF
OKapplication/json
OK
{
  "status": {
    "commonStatus": {
      "uid": "string",
      "uptime": "string",
      "ports": [
        {
          "key": 0
        }
      ],
      "active": true,
      "topologyQueues": {
        "manager": 0,
        "dispatcher": 0,
        "clients": 0
      },
      "components": [
        {
          "name": "string",
          "ok": {}
        }
      ],
      "version": "string"
    },
    "connectedParticipants": [
      {
        "uid": "string"
      }
    ],
    "connectedMediators": [
      {
        "uid": "string"
      }
    ],
    "sequencer": {
      "active": true,
      "details": "string"
    },
    "physicalSynchronizerId": "string",
    "admin": {
      "acceptsAdminChanges": true
    },
    "protocolVersion": 0
  }
}