pldpro_sdk.api_client.NodesApi

All URIs are relative to http://localhost:8086

Method	HTTP request	Description
add_volume_path_to_node	PATCH /api/v1/nodes/{uuid}/add-volume-path	Adiciona um caminho de volume PLDPRO a um Node.
create_node	POST /api/v2/nodes	Cria um Node
delete_node	DELETE /api/v2/nodes/{uuid}	Remove um Node
get_casos_node	GET /api/v1/nodes/{uuid}/cases	Lista os casos associados a um node
get_node_by_uuid	GET /api/v2/nodes/{uuid}	Busca um Node por UUID
get_node_from_name	GET /api/v1/nodes/from-name	Retorna um Node
list_current_user_authorized_nodes	GET /api/v2/nodes/me/auth	Lista Nodes com acesso AuthNode do usuário autenticado
list_current_user_nodes	GET /api/v2/nodes/me	Lista Nodes do usuário autenticado
list_nodes	GET /api/v2/nodes	Lista Nodes
register_full_node	POST /api/v2/nodes/full-register	Registra um Node com sua configuração completa
update_node	PUT /api/v2/nodes/{uuid}	Atualiza um Node
update_nodes_batch	PUT /api/v2/nodes/list	Atualiza Nodes em lote

add_volume_path_to_node

NodeResponse add_volume_path_to_node(uuid, update_cortes_path_request)

Adiciona um caminho de volume PLDPRO a um Node.

Associa um caminho do volume específico do PLDPRO ao Node compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response import NodeResponse
from pldpro_sdk.api_client.models.update_cortes_path_request import UpdateCortesPathRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    update_cortes_path_request = pldpro_sdk.api_client.UpdateCortesPathRequest() # UpdateCortesPathRequest | 

    try:
        # Adiciona um caminho de volume PLDPRO a um Node.
        api_response = api_instance.add_volume_path_to_node(uuid, update_cortes_path_request)
        print("The response of NodesApi->add_volume_path_to_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->add_volume_path_to_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID
update_cortes_path_request	UpdateCortesPathRequest

Return type

NodeResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Node atualizado com sucesso.	-
400	Solicitação do caminho do volume ou Node inválido.	-

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

create_node

NodeResponseDTO create_node(node_request_dto)

Cria um Node

Cria um host de processamento compartilhado usando o contrato genérico de Node.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_request_dto import NodeRequestDTO
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

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

    try:
        # Cria um Node
        api_response = api_instance.create_node(node_request_dto)
        print("The response of NodesApi->create_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->create_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_request_dto	NodeRequestDTO

Return type

NodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Node criado com sucesso.	-
400	Requisição de Node inválida.	-

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

delete_node

delete_node(uuid)

Remove um Node

Remove o Node compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Remove um Node
        api_instance.delete_node(uuid)
    except Exception as e:
        print("Exception when calling NodesApi->delete_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Node removido com sucesso.	-
404	Node não encontrado.	-

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

get_casos_node

List[CaseResponse] get_casos_node(uuid)

Lista os casos associados a um node

Retorna a lista de casos vinculados ao node identificado pelo UUID. Cada caso contém informações básicas como nome, caminhos locais e remotos, e o node relacionado.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do node cujos casos serão listados

    try:
        # Lista os casos associados a um node
        api_response = api_instance.get_casos_node(uuid)
        print("The response of NodesApi->get_casos_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->get_casos_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do node cujos casos serão listados

Return type

List[CaseResponse]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Lista de casos associados ao node. Se não houver casos, retorna uma lista vazia.	-
404	Node não encontrado.	-
400	Erro ao consultar os casos do node.	-

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

get_node_by_uuid

NodeResponseDTO get_node_by_uuid(uuid)

Busca um Node por UUID

Retorna o Node compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Busca um Node por UUID
        api_response = api_instance.get_node_by_uuid(uuid)
        print("The response of NodesApi->get_node_by_uuid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->get_node_by_uuid: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

NodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Node retornado com sucesso.	-
404	Node não encontrado.	-

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

get_node_from_name

NodeResponse get_node_from_name(name)

Retorna um Node

Retorna o node cadastrado a partir do nome.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response import NodeResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    name = 'ampere-cepel' # str | Nome do nó de processamento cadastrado.

    try:
        # Retorna um Node
        api_response = api_instance.get_node_from_name(name)
        print("The response of NodesApi->get_node_from_name:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->get_node_from_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Nome do nó de processamento cadastrado.

Return type

NodeResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Retorna o Node cadastrado.	-
400	Erro ao listar nodes	-

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

list_current_user_authorized_nodes

List[NodeResponseDTO] list_current_user_authorized_nodes()

Lista Nodes com acesso AuthNode do usuário autenticado

Retorna os Nodes nos quais o usuário autenticado possui uma associação AuthNode.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

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

    try:
        # Lista Nodes com acesso AuthNode do usuário autenticado
        api_response = api_instance.list_current_user_authorized_nodes()
        print("The response of NodesApi->list_current_user_authorized_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->list_current_user_authorized_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[NodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Nodes autorizados retornados com sucesso.	-

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

list_current_user_nodes

List[NodeResponseDTO] list_current_user_nodes()

Lista Nodes do usuário autenticado

Retorna os Nodes compartilhados associados ao usuário autenticado.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

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

    try:
        # Lista Nodes do usuário autenticado
        api_response = api_instance.list_current_user_nodes()
        print("The response of NodesApi->list_current_user_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->list_current_user_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[NodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Nodes retornados com sucesso.	-

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

list_nodes

List[NodeResponseDTO] list_nodes()

Lista Nodes

Retorna todos os Nodes compartilhados visíveis para o solicitante.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

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

    try:
        # Lista Nodes
        api_response = api_instance.list_nodes()
        print("The response of NodesApi->list_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->list_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[NodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Nodes retornados com sucesso.	-

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

register_full_node

NodeResponseDTO register_full_node(full_node_registration_dto)

Registra um Node com sua configuração completa

Cria um Node e suas configurações relacionadas em uma única operação genérica.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.full_node_registration_dto import FullNodeRegistrationDTO
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

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

    try:
        # Registra um Node com sua configuração completa
        api_response = api_instance.register_full_node(full_node_registration_dto)
        print("The response of NodesApi->register_full_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->register_full_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
full_node_registration_dto	FullNodeRegistrationDTO

Return type

NodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Node registrado com sucesso.	-
400	Registro completo de Node inválido.	-

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

update_node

NodeResponseDTO update_node(uuid, node_update_dto)

Atualiza um Node

Atualiza o Node compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.models.node_update_dto import NodeUpdateDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    node_update_dto = pldpro_sdk.api_client.NodeUpdateDTO() # NodeUpdateDTO | 

    try:
        # Atualiza um Node
        api_response = api_instance.update_node(uuid, node_update_dto)
        print("The response of NodesApi->update_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->update_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID
node_update_dto	NodeUpdateDTO

Return type

NodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Node atualizado com sucesso.	-
404	Node não encontrado.	-

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

update_nodes_batch

List[NodeResponseDTO] update_nodes_batch(node_update_dto)

Atualiza Nodes em lote

Aplica atualizações genéricas de Node para cada item da lista enviada.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.node_response_dto import NodeResponseDTO
from pldpro_sdk.api_client.models.node_update_dto import NodeUpdateDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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 API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.NodesApi(api_client)
    node_update_dto = [pldpro_sdk.api_client.NodeUpdateDTO()] # List[NodeUpdateDTO] | 

    try:
        # Atualiza Nodes em lote
        api_response = api_instance.update_nodes_batch(node_update_dto)
        print("The response of NodesApi->update_nodes_batch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NodesApi->update_nodes_batch: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_update_dto	List[NodeUpdateDTO]

Return type

List[NodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Nodes atualizados com sucesso.	-

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