Skip to content

Latest commit

 

History

History
269 lines (181 loc) · 6.99 KB

ZonesApi.md

File metadata and controls

269 lines (181 loc) · 6.99 KB
Raw

isi_sdk_8_0.ZonesApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method HTTP request Description
create_zone POST /platform/3/zones
delete_zone DELETE /platform/3/zones/{ZoneId}
get_zone GET /platform/3/zones/{ZoneId}
list_zones GET /platform/3/zones
update_zone PUT /platform/3/zones/{ZoneId}

create_zone

CreateResponse create_zone(zone)

Create a new access zone.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.ZonesApi(isi_sdk_8_0.ApiClient(configuration))
zone = isi_sdk_8_0.ZoneCreateParams() # ZoneCreateParams | 

try:
    api_response = api_instance.create_zone(zone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZonesApi->create_zone: %s\n" % e)

Parameters

Name Type Description Notes
zone ZoneCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

delete_zone

delete_zone(zone_id)

Delete the access zone.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.ZonesApi(isi_sdk_8_0.ApiClient(configuration))
zone_id = 56 # int | Delete the access zone.

try:
    api_instance.delete_zone(zone_id)
except ApiException as e:
    print("Exception when calling ZonesApi->delete_zone: %s\n" % e)

Parameters

Name Type Description Notes
zone_id int Delete the access zone.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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

get_zone

Zones get_zone(zone_id)

Retrieve the access zone information.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.ZonesApi(isi_sdk_8_0.ApiClient(configuration))
zone_id = 56 # int | Retrieve the access zone information.

try:
    api_response = api_instance.get_zone(zone_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZonesApi->get_zone: %s\n" % e)

Parameters

Name Type Description Notes
zone_id int Retrieve the access zone information.

Return type

Zones

Authorization

basicAuth

HTTP request headers

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

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

list_zones

ZonesExtended list_zones()

List all access zones.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.ZonesApi(isi_sdk_8_0.ApiClient(configuration))

try:
    api_response = api_instance.list_zones()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZonesApi->list_zones: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ZonesExtended

Authorization

basicAuth

HTTP request headers

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

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

update_zone

update_zone(zone, zone_id)

Modify the access zone. All input fields are optional, but one or more must be supplied.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.ZonesApi(isi_sdk_8_0.ApiClient(configuration))
zone = isi_sdk_8_0.Zone() # Zone | 
zone_id = 56 # int | Modify the access zone. All input fields are optional, but one or more must be supplied.

try:
    api_instance.update_zone(zone, zone_id)
except ApiException as e:
    print("Exception when calling ZonesApi->update_zone: %s\n" % e)

Parameters

Name Type Description Notes
zone Zone
zone_id int Modify the access zone. All input fields are optional, but one or more must be supplied.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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