REST Interface for OBP

All the administration and configuration steps for setting up and managing your OBP network (as mentioned in previous sections) can also be performed using OBP's Administration REST services. These services are useful for scenarios where the following is required:

  • Reducing the manual mode of these activities
  • Implementing an automated way (such as the DevOps pipeline) for setting up and managing the OBP network
  • Representing OBP administration information in a customized way

These administration REST interfaces include services related to organizations, nodes, channels, and chaincode. Additionally, OBP also provides a bundle of OBP Statistics REST services.

The following is the list of OBP Administration REST services: 

  • Organizations REST endpoints: Under organizations REST endpoints, the following are the list of services:
    • Get organization certificates
    • Get organization admin credentials
    • Get the ordering service settings in a founder organization
    • Join a new organization to a founder organization
    • Set an ordering service to a participant organization
  • Nodes REST endpoint: Under nodes REST endpoint, following are the list of services: 
    • Get node list
    • Get a list of peers on a channel
    • Get a list of peers for a specific chaincode
    • Add a peer node
    • Start/stop a peer node
    • Remove a peer node
    • Get/set a peer node's attributes
    • Join a peer to a channel
    • Export/import peers
    • Start/stop an orderer
    • Get/set an orderer's attributes
    • Start/stop a CA node
    • Get/set a CA's attributes
    • Start/stop REST proxy
    • Get/set REST proxy's configuration
  • Channel REST endpoint: Under channels REST endpoint, the following are the list of services: 
    • Create a channel
    • Get a channel list
    • Get a channel list for chaincode
    • Get a channel list for a peer
    • Update a channel configuration
    • Get a channel information
    • Get a ledger block by block ID
    • Get blocks by ID range
    • Get blocks by time range
  • Chaincode REST endpoint: Under chaincode REST endpoint, the following are the list of services: 
    • Get a list of installed chaincodes
    • Get a list of chaincodes on a specific peer
    • Get a list of chaincodes on a channel
    • Install chaincode
    • Instantiate chaincode
    • Get chaincode info
  • Statistics REST endpoint: Under statistics REST endpoint, the following are the list of services: 
    • List of the currently existing channels and the peers joined on each channel
    • Current number and list of channels joined by the specified peer
    • Current number and list of installed chaincodes on the specified peer
    • Current number of instantiated chaincodes on the specified channel
    • List of configured chaincodes for a specified proxy or for all proxies
    • Node health status
    • Node usage related metrics (CPU, memory, disk usage)
    • Total number of asynchronous invocations
    • Number of billable transactions
    • Number of blocks
    • Number of commits
    • Number of endorsements
    • Total number of synchronous invocations
    • Number of user transactions for peer or channel or the entire network

For more details about these services, please refer to the OBP documentation.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset