Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 3.76 KB

NodesInfoApi.md

File metadata and controls

118 lines (86 loc) · 3.76 KB

Killbill\Client\Swagger\NodesInfoApi

All URIs are relative to /

Method HTTP request Description
getNodesInfo GET /1.0/kb/nodesInfo Retrieve all the nodes infos
triggerNodeCommand POST /1.0/kb/nodesInfo Trigger a node command

getNodesInfo

\Killbill\Client\Swagger\Model\NodeInfo[] getNodesInfo()

Retrieve all the nodes infos

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\NodesInfoApi(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Killbill\Client\Swagger\Model\NodeInfo[]

Authorization

basicAuth

HTTP request headers

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

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

triggerNodeCommand

triggerNodeCommand($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment, $localNodeOnly)

Trigger a node command

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\NodesInfoApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\NodeCommand(); // \Killbill\Client\Swagger\Model\NodeCommand | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 
$localNodeOnly = false; // bool | 

try {
    $apiInstance->triggerNodeCommand($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment, $localNodeOnly);
} catch (Exception $e) {
    echo 'Exception when calling NodesInfoApi->triggerNodeCommand: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Killbill\Client\Swagger\Model\NodeCommand
xKillbillCreatedBy string
xKillbillReason string [optional]
xKillbillComment string [optional]
localNodeOnly bool [optional] [default to false]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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