ParticipantStatus
Documentation Index
Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.
ParticipantStatus
Participant Administration
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-admin-api-protobuf-index">Protobuf</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-admin-api-protobuf-packages-com-digitalasset-canton-admin-participant-v30">com.digitalasset.canton.admin.participant.v30</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>ParticipantStatus</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.digitalasset.canton.admin.participant.v30</p>
<h1 class="x2mdx-ref-title">ParticipantStatus</h1>
<div class="x2mdx-ref-badges">
<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.0</span>
</div>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--rpc">RPC</span>
<code>/com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus</code>
</div>
## Protocol Details
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Protocol</dt>
<dd>gRPC</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Service</dt>
<dd>ParticipantStatusService</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>ParticipantStatus</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
## Inputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>ParticipantStatusRequest</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
</dl>
</div>
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>ParticipantStatusResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">status</code>
<span class="x2mdx-ref-type-badge">ParticipantStatusResponseStatus</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">not\_initialized</code>
<span class="x2mdx-ref-type-badge">NotInitialized</span>
</div>
</div>
</div>
</div>
## Lifecycle Changes
<div class="x2mdx-ref-change-list">
<div class="x2mdx-ref-change-item">
<span class="x2mdx-ref-change-version">3.4.0</span>
<span class="x2mdx-ref-change-detail">introduced</span>
</div>
</div>
## Related Schemas
<AccordionGroup>
<Accordion title="com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-participant-v30-participantstatusrequest" />
</Accordion>
<Accordion title="com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-participant-v30-participantstatusresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">status</code>
<span class="x2mdx-ref-type-badge">ParticipantStatusResponseStatus</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">not\_initialized</code>
<span class="x2mdx-ref-type-badge">NotInitialized</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse.ParticipantStatusResponseStatus">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-participant-v30-participantstatusresponse-participantstatusresponsestatus">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">common\_status</code>
<span class="x2mdx-ref-type-badge">Status</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">connected\_synchronizers</code>
<span class="x2mdx-ref-type-badge">repeated ConnectedSynchronizer</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">active</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">supported\_protocol\_versions</code>
<span class="x2mdx-ref-type-badge">repeated int32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.Status">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-status">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">uid</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">uptime</code>
<span class="x2mdx-ref-type-badge">Duration</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">ports</code>
<span class="x2mdx-ref-type-badge">repeated map</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">active</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">topology\_queues</code>
<span class="x2mdx-ref-type-badge">TopologyQueueStatus</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">components</code>
<span class="x2mdx-ref-type-badge">repeated ComponentStatus</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">version</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.TopologyQueueStatus">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-topologyqueuestatus">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">manager</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">dispatcher</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">clients</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.ComponentStatus">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-componentstatus">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">name</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">ok</code>
<span class="x2mdx-ref-type-badge">StatusData</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">degraded</code>
<span class="x2mdx-ref-type-badge">StatusData</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">failed</code>
<span class="x2mdx-ref-type-badge">StatusData</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">fatal</code>
<span class="x2mdx-ref-type-badge">StatusData</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-componentstatus-statusdata">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">description</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-participant-v30-connectedsynchronizer">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">physical\_synchronizer\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">health</code>
<span class="x2mdx-ref-type-badge">Health</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer.Health">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-participant-v30-connectedsynchronizer-health">
<ul class="x2mdx-ref-enum-list">
<li><code>HEALTH\_UNSPECIFIED</code></li>
<li><code>HEALTH\_HEALTHY</code></li>
<li><code>HEALTH\_UNHEALTHY</code></li>
</ul>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.NotInitialized">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-notinitialized">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">active</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">waiting\_for\_external\_input</code>
<span class="x2mdx-ref-type-badge">WaitingForExternalInput</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">version</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput">
<div class="x2mdx-ref-schema" id="schema-com-digitalasset-canton-admin-health-v30-notinitialized-waitingforexternalinput">
<ul class="x2mdx-ref-enum-list">
<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_UNSPECIFIED</code></li>
<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_ID</code></li>
<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_NODE\_TOPOLOGY</code></li>
<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_INITIALIZATION</code></li>
</ul>
</div>
</Accordion>
</AccordionGroup>
grpcurl
```bash grpcurl theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Add -plaintext if the server is not using TLS.
grpcurl \
-d @ \
<HOST:PORT> \
com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus <<'EOF'
{}
EOF
```
</div>
</div>
<div className="x2mdx-ref-rail-panel">
<div className="x2mdx-ref-rail-code x2mdx-ref-rail-code--response">
<div className="x2mdx-ref-rail-head">
<span className="x2mdx-ref-rail-heading">OK</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json OK theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"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
]
}
}
```
</div>
</div>Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.