Skip to content

Latest commit

 

History

History
328 lines (223 loc) · 9.61 KB

WormApi.md

File metadata and controls

328 lines (223 loc) · 9.61 KB

isi_sdk_8_0.WormApi

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

Method HTTP request Description
create_worm_domain POST /platform/1/worm/domains
get_worm_domain GET /platform/1/worm/domains/{WormDomainId}
get_worm_settings GET /platform/1/worm/settings
list_worm_domains GET /platform/1/worm/domains
update_worm_domain PUT /platform/1/worm/domains/{WormDomainId}
update_worm_settings PUT /platform/1/worm/settings

create_worm_domain

WormDomainExtended create_worm_domain(worm_domain)

Create a WORM domain.

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.WormApi(isi_sdk_8_0.ApiClient(configuration))
worm_domain = isi_sdk_8_0.WormDomainCreateParams() # WormDomainCreateParams | 

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

Parameters

Name Type Description Notes
worm_domain WormDomainCreateParams

Return type

WormDomainExtended

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_worm_domain

WormDomains get_worm_domain(worm_domain_id)

View a single WORM domain.

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.WormApi(isi_sdk_8_0.ApiClient(configuration))
worm_domain_id = 'worm_domain_id_example' # str | View a single WORM domain.

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

Parameters

Name Type Description Notes
worm_domain_id str View a single WORM domain.

Return type

WormDomains

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_worm_settings

WormSettings get_worm_settings()

Get the global WORM settings.

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.WormApi(isi_sdk_8_0.ApiClient(configuration))

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

Parameters

This endpoint does not need any parameter.

Return type

WormSettings

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_worm_domains

WormDomainsExtended list_worm_domains(sort=sort, limit=limit, dir=dir, resume=resume)

List all WORM domains.

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.WormApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | The field that will be used for sorting. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
dir = 'dir_example' # str | The direction of the sort. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)

try:
    api_response = api_instance.list_worm_domains(sort=sort, limit=limit, dir=dir, resume=resume)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WormApi->list_worm_domains: %s\n" % e)

Parameters

Name Type Description Notes
sort str The field that will be used for sorting. [optional]
limit int Return no more than this many results at once (see resume). [optional]
dir str The direction of the sort. [optional]
resume str Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). [optional]

Return type

WormDomainsExtended

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_worm_domain

update_worm_domain(worm_domain, worm_domain_id)

Modify a single WORM domain.

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.WormApi(isi_sdk_8_0.ApiClient(configuration))
worm_domain = isi_sdk_8_0.WormDomain() # WormDomain | 
worm_domain_id = 'worm_domain_id_example' # str | Modify a single WORM domain.

try:
    api_instance.update_worm_domain(worm_domain, worm_domain_id)
except ApiException as e:
    print("Exception when calling WormApi->update_worm_domain: %s\n" % e)

Parameters

Name Type Description Notes
worm_domain WormDomain
worm_domain_id str Modify a single WORM domain.

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]

update_worm_settings

update_worm_settings(worm_settings)

Modify the global WORM settings. 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.WormApi(isi_sdk_8_0.ApiClient(configuration))
worm_settings = isi_sdk_8_0.WormSettingsExtended() # WormSettingsExtended | 

try:
    api_instance.update_worm_settings(worm_settings)
except ApiException as e:
    print("Exception when calling WormApi->update_worm_settings: %s\n" % e)

Parameters

Name Type Description Notes
worm_settings WormSettingsExtended

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]