R3 Docs R3 Docs Home

Retrieving Virtual Nodes heading-link-icon

This section describes how to retrieve information about virtual nodes in a cluster. It contains the following:

To retrieve a list of all virtual nodes in the cluster A complete set of worker processes. Clusters require a fully functioning virtual node infrastructure. , use the GET method of the /api/v5_1/virtualnode endpoint :

curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/api/v5_1/virtualnode

Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $REST_API_USER:$REST_API_PASSWORD)} -Uri $REST_API_URL/api/v5_1/virtualnode
```shell

This endpoint returns the list of all virtual nodes in the cluster as an array of VirtualNodeInfo objects in the following format:

{
  "virtualNodes": [
    {
      "cpiIdentifier": {
        "cpiName": "string",
        "cpiVersion": "string",
        "signerSummaryHash": "string"
      },
      "cryptoDdlConnectionId": "string",
      "cryptoDmlConnectionId": "string",
      "flowOperationalStatus": "INACTIVE",
      "flowP2pOperationalStatus": "INACTIVE",
      "flowStartOperationalStatus": "INACTIVE",
      "holdingIdentity": {
        "fullHash": "string",
        "groupId": "string",
        "shortHash": "string",
        "x500Name": "string"
      },
      "hsmConnectionId": "string",
      "operationInProgress": "string",
      "uniquenessDdlConnectionId": "string",
      "uniquenessDmlConnectionId": "string",
      "vaultDbOperationalStatus": "INACTIVE",
      "vaultDdlConnectionId": "string",
      "vaultDmlConnectionId": "string"
    }
  ]
}

To retrieve information about the virtual node The combination of the context of a user and the ephemeral compute instances created to progress a transaction on that identity's behalf. of a specific member Corda identity that has been granted admission to a membership group. Synonym for a virtual node or group member. in the cluster, use the GET method of the /api/v5_1/virtualnode/<holdingidentityshorthash> endpoint :

curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/api/v5_1/virtualnode/<holdingidentityshorthash>

Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $REST_API_USER:$REST_API_PASSWORD)} -Uri $REST_API_URL/api/v5_1/virtulnode/<holdingidentityshorthash>

This endpoint returns a VirtualNodeInfo object for the specified member in the following format:

{
  "cpiIdentifier": {
    "cpiName": "string",
    "cpiVersion": "string",
    "signerSummaryHash": "string"
  },
  "cryptoDdlConnectionId": "string",
  "cryptoDmlConnectionId": "string",
  "flowOperationalStatus": "INACTIVE",
  "flowP2pOperationalStatus": "INACTIVE",
  "flowStartOperationalStatus": "INACTIVE",
  "holdingIdentity": {
    "fullHash": "string",
    "groupId": "string",
    "shortHash": "string",
    "x500Name": "string"
  },
  "hsmConnectionId": "string",
  "operationInProgress": "string",
  "uniquenessDdlConnectionId": "string",
  "uniquenessDmlConnectionId": "string",
  "vaultDbOperationalStatus": "INACTIVE",
  "vaultDdlConnectionId": "string",
  "vaultDmlConnectionId": "string"
}
Previous
Managing Virtual Nodes
Next
Setting the State of Virtual Nodes

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Create a new issue
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how