Skip to content

Latest commit

 

History

History
192 lines (132 loc) · 4.64 KB

NodeApi.md

File metadata and controls

192 lines (132 loc) · 4.64 KB

sdx_lc_client.NodeApi

All URIs are relative to https://virtserver.swaggerhub.com/SDX-LC/2.0.0

Method HTTP request Description
add_node POST /node add a new node to the topology
delete_node DELETE /node Deletes a node
get_node GET /node get an existing node
update_node PUT /node Update an existing node

add_node

Node add_node(body)

add a new node to the topology

Example

from __future__ import print_function
import time
import sdx_lc_client
from sdx_lc_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = sdx_lc_client.NodeApi()
body = sdx_lc_client.Node() # Node | node object that needs to be sent to the SDX LC

try:
    # add a new node to the topology
    api_response = api_instance.add_node(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodeApi->add_node: %s\n" % e)

Parameters

Name Type Description Notes
body Node node object that needs to be sent to the SDX LC

Return type

Node

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

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

delete_node

delete_node(node_id)

Deletes a node

Example

from __future__ import print_function
import time
import sdx_lc_client
from sdx_lc_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = sdx_lc_client.NodeApi()
node_id = 789 # int | ID of node to delete

try:
    # Deletes a node
    api_instance.delete_node(node_id)
except ApiException as e:
    print("Exception when calling NodeApi->delete_node: %s\n" % e)

Parameters

Name Type Description Notes
node_id int ID of node to delete

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

get_node

get_node()

get an existing node

ID of the node

Example

from __future__ import print_function
import time
import sdx_lc_client
from sdx_lc_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = sdx_lc_client.NodeApi()

try:
    # get an existing node
    api_instance.get_node()
except ApiException as e:
    print("Exception when calling NodeApi->get_node: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

update_node

update_node(body)

Update an existing node

ID of node that needs to be updated.

Example

from __future__ import print_function
import time
import sdx_lc_client
from sdx_lc_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = sdx_lc_client.NodeApi()
body = sdx_lc_client.Node() # Node | node object that needs to be sent to the SDX LC

try:
    # Update an existing node
    api_instance.update_node(body)
except ApiException as e:
    print("Exception when calling NodeApi->update_node: %s\n" % e)

Parameters

Name Type Description Notes
body Node node object that needs to be sent to the SDX LC

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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