Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesParticipantStatusServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesParticipantStatusService

ParticipantStatus

Participant Administration›Protobuf›com.digitalasset.canton.admin.participant.v30›ParticipantStatus

com.digitalasset.canton.admin.participant.v30

​
ParticipantStatus

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus

​
Protocol Details

​
Inputs

​
ParticipantStatusRequest

​
Outputs

​
ParticipantStatusResponse

statusParticipantStatusResponseStatus
not_initializedNotInitialized

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest

com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse

statusParticipantStatusResponseStatus
not_initializedNotInitialized

com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse.ParticipantStatusResponseStatus

common_statusStatus
connected_synchronizersrepeated ConnectedSynchronizer
activebool
supported_protocol_versionsrepeated int32

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.participant.v30.ConnectedSynchronizer

physical_synchronizer_idstring
healthHealth

com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer.Health

  • HEALTH_UNSPECIFIED
  • HEALTH_HEALTHY
  • HEALTH_UNHEALTHY

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.participant.v30.ParticipantStatusService/ParticipantStatus <<'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"
    },
    "connectedSynchronizers": [
      {
        "physicalSynchronizerId": "string",
        "health": "HEALTH_UNSPECIFIED"
      }
    ],
    "active": true,
    "supportedProtocolVersions": [
      0
    ]
  }
}