garage-admin-sdk-generator/python/docs/NodesApi.md

garage_admin_sdk.NodesApi

All URIs are relative to http://localhost:3903/v0

Method	HTTP request	Description
add_node	POST /connect	Connect target node to other Garage nodes
get_nodes	GET /status	Status of this node and other nodes in the cluster

add_node

[AddNode200ResponseInner] add_node()

Connect target node to other Garage nodes

Instructs this Garage node to connect to other Garage nodes at specified <node_id>@<net_address>. node_id is generated automatically on node start.

Example

• Bearer Authentication (bearerAuth):

import time
import garage_admin_sdk
from garage_admin_sdk.api import nodes_api
from garage_admin_sdk.model.add_node200_response_inner import AddNode200ResponseInner
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = garage_admin_sdk.Configuration(
    host = "http://localhost:3903/v0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = garage_admin_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with garage_admin_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)
    request_body = ["ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f@10.0.0.11:3901","4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff@10.0.0.12:3901"] # [str] |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Connect target node to other Garage nodes
        api_response = api_instance.add_node(request_body=request_body)
        pprint(api_response)
    except garage_admin_sdk.ApiException as e:
        print("Exception when calling NodesApi->add_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	[str]		[optional]

Return type

[AddNode200ResponseInner]

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
500	The server can not answer your request because it is in a bad state	-
400	Your request is malformed, check your JSON	-
200	The request has been handled correctly but it does not mean that all connection requests succeeded; some might have fail, you need to check the body!	-

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

get_nodes

GetNodes200Response get_nodes()

Status of this node and other nodes in the cluster

Returns the cluster's current status, including: - ID of the node being queried and its version of the Garage daemon - Live nodes - Currently configured cluster layout - Staged changes to the cluster layout

Example

• Bearer Authentication (bearerAuth):

import time
import garage_admin_sdk
from garage_admin_sdk.api import nodes_api
from garage_admin_sdk.model.get_nodes200_response import GetNodes200Response
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = garage_admin_sdk.Configuration(
    host = "http://localhost:3903/v0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = garage_admin_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with garage_admin_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Status of this node and other nodes in the cluster
        api_response = api_instance.get_nodes()
        pprint(api_response)
    except garage_admin_sdk.ApiException as e:
        print("Exception when calling NodesApi->get_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetNodes200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
500	The server can not answer your request because it is in a bad state	-
200	Information about the queried node, its environment and the current layout	-

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