github.com/filecoin-project/bacalhau@v0.3.23-0.20230228154132-45c989550ace/clients/python/docs/UtilsApi.md (about)

     1  # bacalhau_apiclient.UtilsApi
     2  
     3  All URIs are relative to *http://bootstrap.production.bacalhau.org:1234*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**healthz**](UtilsApi.md#healthz) | **GET** /healthz | 
     8  [**id**](UtilsApi.md#id) | **GET** /id | Returns the id of the host node.
     9  [**livez**](UtilsApi.md#livez) | **GET** /livez | 
    10  [**logz**](UtilsApi.md#logz) | **GET** /logz | 
    11  [**node_info**](UtilsApi.md#node_info) | **GET** /node_info | Returns the info of the node.
    12  [**peers**](UtilsApi.md#peers) | **GET** /peers | Returns the peers connected to the host via the transport layer.
    13  [**readyz**](UtilsApi.md#readyz) | **GET** /readyz | 
    14  [**varz**](UtilsApi.md#varz) | **GET** /varz | 
    15  
    16  
    17  # **healthz**
    18  > HealthInfo healthz()
    19  
    20  
    21  
    22  ### Example
    23  ```python
    24  from __future__ import print_function
    25  import time
    26  import bacalhau_apiclient
    27  from bacalhau_apiclient.rest import ApiException
    28  from pprint import pprint
    29  
    30  # create an instance of the API class
    31  api_instance = bacalhau_apiclient.UtilsApi()
    32  
    33  try:
    34      api_response = api_instance.healthz()
    35      pprint(api_response)
    36  except ApiException as e:
    37      print("Exception when calling UtilsApi->healthz: %s\n" % e)
    38  ```
    39  
    40  ### Parameters
    41  This endpoint does not need any parameter.
    42  
    43  ### Return type
    44  
    45  [**HealthInfo**](HealthInfo.md)
    46  
    47  ### Authorization
    48  
    49  No authorization required
    50  
    51  ### HTTP request headers
    52  
    53   - **Content-Type**: Not defined
    54   - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    57  
    58  # **id**
    59  > str id()
    60  
    61  Returns the id of the host node.
    62  
    63  ### Example
    64  ```python
    65  from __future__ import print_function
    66  import time
    67  import bacalhau_apiclient
    68  from bacalhau_apiclient.rest import ApiException
    69  from pprint import pprint
    70  
    71  # create an instance of the API class
    72  api_instance = bacalhau_apiclient.UtilsApi()
    73  
    74  try:
    75      # Returns the id of the host node.
    76      api_response = api_instance.id()
    77      pprint(api_response)
    78  except ApiException as e:
    79      print("Exception when calling UtilsApi->id: %s\n" % e)
    80  ```
    81  
    82  ### Parameters
    83  This endpoint does not need any parameter.
    84  
    85  ### Return type
    86  
    87  **str**
    88  
    89  ### Authorization
    90  
    91  No authorization required
    92  
    93  ### HTTP request headers
    94  
    95   - **Content-Type**: Not defined
    96   - **Accept**: text/plain
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    99  
   100  # **livez**
   101  > str livez()
   102  
   103  
   104  
   105  ### Example
   106  ```python
   107  from __future__ import print_function
   108  import time
   109  import bacalhau_apiclient
   110  from bacalhau_apiclient.rest import ApiException
   111  from pprint import pprint
   112  
   113  # create an instance of the API class
   114  api_instance = bacalhau_apiclient.UtilsApi()
   115  
   116  try:
   117      api_response = api_instance.livez()
   118      pprint(api_response)
   119  except ApiException as e:
   120      print("Exception when calling UtilsApi->livez: %s\n" % e)
   121  ```
   122  
   123  ### Parameters
   124  This endpoint does not need any parameter.
   125  
   126  ### Return type
   127  
   128  **str**
   129  
   130  ### Authorization
   131  
   132  No authorization required
   133  
   134  ### HTTP request headers
   135  
   136   - **Content-Type**: Not defined
   137   - **Accept**: text/plain
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   140  
   141  # **logz**
   142  > str logz()
   143  
   144  
   145  
   146  ### Example
   147  ```python
   148  from __future__ import print_function
   149  import time
   150  import bacalhau_apiclient
   151  from bacalhau_apiclient.rest import ApiException
   152  from pprint import pprint
   153  
   154  # create an instance of the API class
   155  api_instance = bacalhau_apiclient.UtilsApi()
   156  
   157  try:
   158      api_response = api_instance.logz()
   159      pprint(api_response)
   160  except ApiException as e:
   161      print("Exception when calling UtilsApi->logz: %s\n" % e)
   162  ```
   163  
   164  ### Parameters
   165  This endpoint does not need any parameter.
   166  
   167  ### Return type
   168  
   169  **str**
   170  
   171  ### Authorization
   172  
   173  No authorization required
   174  
   175  ### HTTP request headers
   176  
   177   - **Content-Type**: Not defined
   178   - **Accept**: text/plain
   179  
   180  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   181  
   182  # **node_info**
   183  > NodeInfo node_info()
   184  
   185  Returns the info of the node.
   186  
   187  ### Example
   188  ```python
   189  from __future__ import print_function
   190  import time
   191  import bacalhau_apiclient
   192  from bacalhau_apiclient.rest import ApiException
   193  from pprint import pprint
   194  
   195  # create an instance of the API class
   196  api_instance = bacalhau_apiclient.UtilsApi()
   197  
   198  try:
   199      # Returns the info of the node.
   200      api_response = api_instance.node_info()
   201      pprint(api_response)
   202  except ApiException as e:
   203      print("Exception when calling UtilsApi->node_info: %s\n" % e)
   204  ```
   205  
   206  ### Parameters
   207  This endpoint does not need any parameter.
   208  
   209  ### Return type
   210  
   211  [**NodeInfo**](NodeInfo.md)
   212  
   213  ### Authorization
   214  
   215  No authorization required
   216  
   217  ### HTTP request headers
   218  
   219   - **Content-Type**: Not defined
   220   - **Accept**: application/json
   221  
   222  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   223  
   224  # **peers**
   225  > list[PeerAddrInfo] peers()
   226  
   227  Returns the peers connected to the host via the transport layer.
   228  
   229  As described in the [architecture docs](https://docs.bacalhau.org/about-bacalhau/architecture), each node is connected to a number of peer nodes.  Example response: ```json {   \"bacalhau-job-event\": [     \"QmdZQ7ZbhnvWY1J12XYKGHApJ6aufKyLNSvf8jZBrBaAVL\",     \"QmXaXu9N5GNetatsvwnTfQqNtSeKAD6uCmarbh3LMRYAcF\",     \"QmVAb7r2pKWCuyLpYWoZr9syhhFnTWeFaByHdb8PkkhLQG\",     \"QmUDAXvv31WPZ8U9CzuRTMn9iFGiopGE7rHiah1X8a6PkT\",     \"QmSyJ8VUd4YSPwZFJSJsHmmmmg7sd4BAc2yHY73nisJo86\"   ] } ```
   230  
   231  ### Example
   232  ```python
   233  from __future__ import print_function
   234  import time
   235  import bacalhau_apiclient
   236  from bacalhau_apiclient.rest import ApiException
   237  from pprint import pprint
   238  
   239  # create an instance of the API class
   240  api_instance = bacalhau_apiclient.UtilsApi()
   241  
   242  try:
   243      # Returns the peers connected to the host via the transport layer.
   244      api_response = api_instance.peers()
   245      pprint(api_response)
   246  except ApiException as e:
   247      print("Exception when calling UtilsApi->peers: %s\n" % e)
   248  ```
   249  
   250  ### Parameters
   251  This endpoint does not need any parameter.
   252  
   253  ### Return type
   254  
   255  [**list[PeerAddrInfo]**](PeerAddrInfo.md)
   256  
   257  ### Authorization
   258  
   259  No authorization required
   260  
   261  ### HTTP request headers
   262  
   263   - **Content-Type**: Not defined
   264   - **Accept**: application/json
   265  
   266  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   267  
   268  # **readyz**
   269  > str readyz()
   270  
   271  
   272  
   273  ### Example
   274  ```python
   275  from __future__ import print_function
   276  import time
   277  import bacalhau_apiclient
   278  from bacalhau_apiclient.rest import ApiException
   279  from pprint import pprint
   280  
   281  # create an instance of the API class
   282  api_instance = bacalhau_apiclient.UtilsApi()
   283  
   284  try:
   285      api_response = api_instance.readyz()
   286      pprint(api_response)
   287  except ApiException as e:
   288      print("Exception when calling UtilsApi->readyz: %s\n" % e)
   289  ```
   290  
   291  ### Parameters
   292  This endpoint does not need any parameter.
   293  
   294  ### Return type
   295  
   296  **str**
   297  
   298  ### Authorization
   299  
   300  No authorization required
   301  
   302  ### HTTP request headers
   303  
   304   - **Content-Type**: Not defined
   305   - **Accept**: text/plain
   306  
   307  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   308  
   309  # **varz**
   310  > list[int] varz()
   311  
   312  
   313  
   314  ### Example
   315  ```python
   316  from __future__ import print_function
   317  import time
   318  import bacalhau_apiclient
   319  from bacalhau_apiclient.rest import ApiException
   320  from pprint import pprint
   321  
   322  # create an instance of the API class
   323  api_instance = bacalhau_apiclient.UtilsApi()
   324  
   325  try:
   326      api_response = api_instance.varz()
   327      pprint(api_response)
   328  except ApiException as e:
   329      print("Exception when calling UtilsApi->varz: %s\n" % e)
   330  ```
   331  
   332  ### Parameters
   333  This endpoint does not need any parameter.
   334  
   335  ### Return type
   336  
   337  **list[int]**
   338  
   339  ### Authorization
   340  
   341  No authorization required
   342  
   343  ### HTTP request headers
   344  
   345   - **Content-Type**: Not defined
   346   - **Accept**: application/json
   347  
   348  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   349