Skip to content

Latest commit

 

History

History
385 lines (249 loc) · 8.96 KB

NodeRoutesApi.md

File metadata and controls

385 lines (249 loc) · 8.96 KB

SymbolRestClient\NodeRoutesApi

All URIs are relative to http://localhost:3000, except if the operation defines another base path.

Method HTTP request Description
getNodeHealth() GET /node/health Get the node health information
getNodeInfo() GET /node/info Get the node information
getNodePeers() GET /node/peers Get peers information
getNodeStorage() GET /node/storage Get the storage information of the node
getNodeTime() GET /node/time Get the node time
getServerInfo() GET /node/server Get the version of the running REST component
getUnlockedAccount() GET /node/unlockedaccount Get the unlocked harvesting account public keys.

getNodeHealth()

getNodeHealth(): \SymbolRestClient\Model\NodeHealthInfoDTO

Get the node health information

Supplies information regarding the connection and services status.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNodeHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getNodeHealth: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\NodeHealthInfoDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodeInfo()

getNodeInfo(): \SymbolRestClient\Model\NodeInfoDTO

Get the node information

Supplies additional information about the application running on a node.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNodeInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getNodeInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\NodeInfoDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodePeers()

getNodePeers(): \SymbolRestClient\Model\NodeInfoDTO[]

Get peers information

Gets the list of peers visible by the node.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNodePeers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getNodePeers: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\NodeInfoDTO[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodeStorage()

getNodeStorage(): \SymbolRestClient\Model\StorageInfoDTO

Get the storage information of the node

Returns storage information about the node.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNodeStorage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getNodeStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\StorageInfoDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodeTime()

getNodeTime(): \SymbolRestClient\Model\NodeTimeDTO

Get the node time

Gets the node time at the moment the reply was sent and received.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNodeTime();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getNodeTime: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\NodeTimeDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getServerInfo()

getServerInfo(): \SymbolRestClient\Model\ServerInfoDTO

Get the version of the running REST component

Returns the version of the running catapult-rest component.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getServerInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getServerInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\ServerInfoDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUnlockedAccount()

getUnlockedAccount(): \SymbolRestClient\Model\UnlockedAccountDTO

Get the unlocked harvesting account public keys.

Returns array of unlocked account public keys.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SymbolRestClient\Api\NodeRoutesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getUnlockedAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeRoutesApi->getUnlockedAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SymbolRestClient\Model\UnlockedAccountDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]