fusion.ArraysApi

All URIs are relative to https://api.pure1.purestorage.com/fusion/api/1.2

Method	HTTP request	Description
create_array	POST /regions/{region_name}/availability-zones/{availability_zone_name}/arrays	(Provider) Registers an array into Pure Fusion.
delete_array	DELETE /regions/{region_name}/availability-zones/{availability_zone_name}/arrays/{array_name}	Deregister a specific array.
get_array	GET /regions/{region_name}/availability-zones/{availability_zone_name}/arrays/{array_name}	(Provider) Gets a specific Array.
get_array_by_id	GET /resources/arrays/{array_id}	(Provider) Gets a specific Array.
get_array_performance	GET /regions/{region_name}/availability-zones/{availability_zone_name}/arrays/{array_name}/performance	(Provider) Gets performance metrics of a specific Array.
get_array_space	GET /regions/{region_name}/availability-zones/{availability_zone_name}/arrays/{array_name}/space	(Provider) Gets performance metrics of a specific Array.
list_arrays	GET /regions/{region_name}/availability-zones/{availability_zone_name}/arrays	(Provider) Gets a list of all arrays registered to Pure Fusion.
update_array	PATCH /regions/{region_name}/availability-zones/{availability_zone_name}/arrays/{array_name}	Updates a specific array.

create_array

Operation create_array(body, region_name, availability_zone_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Registers an array into Pure Fusion.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
body = fusion.ArrayPost() # ArrayPost | 
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Registers an array into Pure Fusion.
    api_response = api_instance.create_array(body, region_name, availability_zone_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->create_array: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ArrayPost
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

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_array

Operation delete_array(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Deregister a specific array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
array_name = 'array_name_example' # str | The Array name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Deregister a specific array.
    api_response = api_instance.delete_array(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->delete_array: %s\n" % e)

Parameters

Name	Type	Description	Notes
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
array_name	str	The Array name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_array

Array get_array(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Gets a specific Array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
array_name = 'array_name_example' # str | The Array name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Gets a specific Array.
    api_response = api_instance.get_array(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->get_array: %s\n" % e)

Parameters

Name	Type	Description	Notes
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
array_name	str	The Array name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Array

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_array_by_id

Array get_array_by_id(array_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Gets a specific Array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
array_id = 'array_id_example' # str | The Array ID
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Gets a specific Array.
    api_response = api_instance.get_array_by_id(array_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->get_array_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
array_id	str	The Array ID
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Array

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_array_performance

Performance get_array_performance(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Gets performance metrics of a specific Array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
array_name = 'array_name_example' # str | The Array name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Gets performance metrics of a specific Array.
    api_response = api_instance.get_array_performance(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->get_array_performance: %s\n" % e)

Parameters

Name	Type	Description	Notes
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
array_name	str	The Array name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Performance

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_array_space

Space get_array_space(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Gets performance metrics of a specific Array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
array_name = 'array_name_example' # str | The Array name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Gets performance metrics of a specific Array.
    api_response = api_instance.get_array_space(region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->get_array_space: %s\n" % e)

Parameters

Name	Type	Description	Notes
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
array_name	str	The Array name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Space

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_arrays

ArrayList list_arrays(region_name, availability_zone_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

(Provider) Gets a list of all arrays registered to Pure Fusion.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # (Provider) Gets a list of all arrays registered to Pure Fusion.
    api_response = api_instance.list_arrays(region_name, availability_zone_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->list_arrays: %s\n" % e)

Parameters

Name	Type	Description	Notes
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

ArrayList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

update_array

Operation update_array(body, region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Updates a specific array.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.ArraysApi(fusion.ApiClient(configuration))
body = fusion.ArrayPatch() # ArrayPatch | 
region_name = 'region_name_example' # str | The Region name
availability_zone_name = 'availability_zone_name_example' # str | The Availability Zone name
array_name = 'array_name_example' # str | The Array name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Updates a specific array.
    api_response = api_instance.update_array(body, region_name, availability_zone_name, array_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArraysApi->update_array: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ArrayPatch
region_name	str	The Region name
availability_zone_name	str	The Availability Zone name
array_name	str	The Array name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

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

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

FilesExpand file tree

ArraysApi.md

Latest commit

History

ArraysApi.md

File metadata and controls

fusion.ArraysApi

create_array

Example

Parameters

Return type

Authorization

HTTP request headers

delete_array

Example

Parameters

Return type

Authorization

HTTP request headers

get_array

Example

Parameters

Return type

Authorization

HTTP request headers

get_array_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_array_performance

Example

Parameters

Return type

Authorization

HTTP request headers

get_array_space

Example

Parameters

Return type

Authorization

HTTP request headers

list_arrays

Example

Parameters

Return type

Authorization

HTTP request headers

update_array

Example

Parameters

Return type

Authorization

HTTP request headers