Gateway-API Commands
Command | Description |
| Get the status of the Gateway. It accepts an [optional] parameter that can be 'SUMMARY’ [default] or ‘DETAILED’ |
| Get the memory utilization of the Gateway |
| Get the list of peers connected to the Gateway |
| Get percentage of blocks/transactions first received from the BDN |
| Shutdown the Gateway |
| Print detailed help |
We assume that the Gateway IP is 127.0.0.1 with port 28332
curl http://127.0.0.1:28332 \-X POST \-H "Content-Type: application/json" \-H "Authorization: <YOUR-AUTHORIZATION-HEADER>" \-d '{"method": "gateway_status", "id": "1", "params": {"details_level": "summary"}}'
curl http://127.0.0.1:28332 \-X POST \-H "Content-Type: application/json" \-H "Authorization: <YOUR-AUTHORIZATION-HEADER>" \-d '{"method": "memory", "id": "1", "params": null}'
curl http://127.0.0.1:28332 \-X POST \-H "Content-Type: application/json" \-H "Authorization: <YOUR-AUTHORIZATION-HEADER>" \-d '{"method": "peers", "id": "1", "params": null}'
curl http://127.0.0.1:28332 \-X POST \-H "Content-Type: application/json" \-H "Authorization: <YOUR-AUTHORIZATION-HEADER>" \-d '{"method": "bdn_performance", "id": "1", "params": null}'
Result Field | Description |
| The status of the Gateway, e.g., Online. |
| Information about the account, e.g., The account ID or Gateway not registered to any account ID. |
| The state of the block Relay connection, e.g., Established. |
| The state of the transaction Relay connection, e.g., Established. |
| The state of the blockchain node connection, e.g., Established. |
| The Gateway's IP address, e.g., 11.22.33.44. |
| The continent at which the Gateway resides, e.g., NA (North America). |
| The country in which the Gateway resides, e.g., United States. |
| Indicates if the Gateway needs to be updated, e.g., false. |
| The percent of transactions that have been sent, relative to the |
Result Field | Description |
| The total number of cached transactions, e.g., 46186. |
| The total memory usage, e.g., 257 MB. |
| The total size of cashed transactions, e.g., 8 MB. |
Result Field | Description |
| The peer's id, e.g., null. |
| The type of the peer, e.g., BLOCKCHAIN_NODE. |
| The IP address and port number of the peer, e.g., 172.17.0.1 30303. |
| The peer's direction, e.g., OUTBOUND. |
| The connection state, e.g., CONNECTING. |
Result Field | Description |
| The interval start time, e.g., 2020-09-01 22.10.52.063009. |
| The interval end time, e.g., 2020-09-01 22.25.52.096951. |
| The percent of blocks received from the BDN, relative to all received blocks, e.g., 90.72%. |
| The percent of transactions received from the BDN, relative to all received transactions, e.g., 79.13%. |
{"jsonrpc": "2.0","id": "1","result": {"gateway_status": "Online","account_info": "This gateway is not registered to any account and is limited to the daily free quota","block_relay_connection_state": "Established","transaction_relay_connection_state": "Established","blockchain_node_connection_state": "Established","remote_blockchain_node_connection_state": "Established","ip_address": "11.22.33.44","continent": "NA","country": "United States","update_required": false,"quota_level": "0%"}}
{"jsonrpc": "2.0","id": "1","result": {"total_mem_usage": "257 MB","total_cached_transactions": 46186,"total_cached_transactions_size": "8 MB"}}
{"jsonrpc": "2.0","id": "1","result": [{"id": null,"type": "BLOCKCHAIN_NODE","addr": "172.17.0.1 30303","direction": "OUTBOUND","state": "CONNECTING"},{...}]}
{"jsonrpc": "2.0","id": "1","result": {"interval_start_time": "2020-09-01 22:10:52.063009","interval_end_time": "2020-09-01 22:25:52.096951","blocks_from_bdn_percentage": "90.72%","transactions_from_bdn_percentage": "79.13%"}}
