Skip to content

Latest commit

 

History

History
1527 lines (1167 loc) · 62.5 KB

File metadata and controls

1527 lines (1167 loc) · 62.5 KB

greenlake_data_services.StoragePoolsApi

All URIs are relative to https://eu1.data.cloud.hpe.com

Method HTTP request Description
device_type1_storage_pool_get_by_id GET /api/v1/storage-systems/device-type1/{systemId}/storage-pools/{id} Get details of Primera / Alletra 9K storage-pool identified by {id}
device_type1_storage_pool_list GET /api/v1/storage-systems/device-type1/{systemId}/storage-pools Get all storage-pools details by Primera / Alletra 9K
device_type1_storage_pool_volume_get_by_id GET /api/v1/storage-systems/device-type1/{systemId}/storage-pools/{id}/volumes Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K
device_type2_create_pool POST /api/v1/storage-systems/device-type2/{systemId}/storage-pools Create storage pool from Nimble / Alletra 6K system identified by {systemId}
device_type2_edit_pool_detail_by_id PUT /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId} Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}
device_type2_get_all_pool_details GET /api/v1/storage-systems/device-type2/{systemId}/storage-pools Get all pools details by Nimble / Alletra 6K
device_type2_get_pool_capacity_history GET /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId}/capacity-history Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
device_type2_get_pool_detail_by_id GET /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId} Get details of Nimble / Alletra 6K pool identified by {storagePoolId}
device_type2_get_pool_performance_history GET /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId}/performance-history Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
device_type2_get_pool_performance_statistics GET /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId}/performance-statistics Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}
device_type2_merge_pool_by_id POST /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId}/actions/merge Merge pool identified by {storagePoolId} from Nimble / Alletra 6K
device_type2_remove_pool_by_id DELETE /api/v1/storage-systems/device-type2/{systemId}/storage-pools/{storagePoolId} Delete pool identified by {storagePoolId} from Nimble / Alletra 6K
storage_pool_volumes_list GET /api/v1/storage-systems/{systemId}/storage-pools/{id}/volumes Get all volumes for storage-pool identified by {id}
storage_pools_get_by_id GET /api/v1/storage-systems/{systemId}/storage-pools/{id} Get details of storage pools identified by {id}
storage_pools_list GET /api/v1/storage-systems/{systemId}/storage-pools Get all storage pools for a device {systemId}

device_type1_storage_pool_get_by_id

PrimeraPoolDetails device_type1_storage_pool_get_by_id(system_id, id)

Get details of Primera / Alletra 9K storage-pool identified by {id}

Get details of Primera / Alletra 9K storage-pool identified by {id}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.primera_pool_details import PrimeraPoolDetails
from greenlake_data_services.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "147c439db3ecb34d1ccccc932d14fd60" # str | Identifier of pool. A 32 digit number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of Primera / Alletra 9K storage-pool identified by {id}
        api_response = api_instance.device_type1_storage_pool_get_by_id(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of Primera / Alletra 9K storage-pool identified by {id}
        api_response = api_instance.device_type1_storage_pool_get_by_id(system_id, id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str Identifier of pool. A 32 digit number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraPoolDetails

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type1_storage_pool_list

PrimeraPoolsSummaryList device_type1_storage_pool_list(system_id)

Get all storage-pools details by Primera / Alletra 9K

Get all storage-pools details by Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.primera_pools_summary_list import PrimeraPoolsSummaryList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq CPG_1" # str | oData query to filter pools by Key. (optional)
    sort = "name desc" # str | oData query to sort pools by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all storage-pools details by Primera / Alletra 9K
        api_response = api_instance.device_type1_storage_pool_list(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all storage-pools details by Primera / Alletra 9K
        api_response = api_instance.device_type1_storage_pool_list(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_list: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter pools by Key. [optional]
sort str oData query to sort pools by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraPoolsSummaryList

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type1_storage_pool_volume_get_by_id

PrimeraVolumesList device_type1_storage_pool_volume_get_by_id(system_id, id)

Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K

Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.primera_volumes_list import PrimeraVolumesList
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "147c439db3ecb34d1ccccc932d14fd60" # str | Identifier of pool. A 32 digit number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K
        api_response = api_instance.device_type1_storage_pool_volume_get_by_id(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_volume_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K
        api_response = api_instance.device_type1_storage_pool_volume_get_by_id(system_id, id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type1_storage_pool_volume_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str Identifier of pool. A 32 digit number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraVolumesList

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_create_pool

TaskResponse device_type2_create_pool(system_id, nimble_create_pool_input)

Create storage pool from Nimble / Alletra 6K system identified by {systemId}

Create storage pool from Nimble / Alletra 6K system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from greenlake_data_services.model.nimble_create_pool_input import NimbleCreatePoolInput
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    nimble_create_pool_input = NimbleCreatePoolInput(
        array_list=[
            CreatePoolNimbleArrayDetail(
                id="2a0df0fe6f7dc7bb16000000000000000000004801",
            ),
        ],
        dedupe_all_volumes=False,
        description="99.9999% availability",
        name="pool-1",
    ) # NimbleCreatePoolInput | 

    # example passing only required values which don't have defaults set
    try:
        # Create storage pool from Nimble / Alletra 6K  system identified by {systemId}
        api_response = api_instance.device_type2_create_pool(system_id, nimble_create_pool_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_create_pool: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
nimble_create_pool_input NimbleCreatePoolInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_edit_pool_detail_by_id

TaskResponse device_type2_edit_pool_detail_by_id(system_id, storage_pool_id, nimble_edit_pool_input)

Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}

Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.nimble_edit_pool_input import NimbleEditPoolInput
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of pool. A 42 digit hexadecimal number.
    nimble_edit_pool_input = NimbleEditPoolInput(
        array_list=[
            EditPoolNimbleArrayDetail(
                id="2a0df0fe6f7dc7bb16000000000000000000004801",
            ),
        ],
        dedupe_all_volumes=False,
        dedupe_capable=False,
        description="99.9999% availability",
        force=False,
        is_default=False,
        name="pool-1",
    ) # NimbleEditPoolInput | 

    # example passing only required values which don't have defaults set
    try:
        # Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}
        api_response = api_instance.device_type2_edit_pool_detail_by_id(system_id, storage_pool_id, nimble_edit_pool_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_edit_pool_detail_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of pool. A 42 digit hexadecimal number.
nimble_edit_pool_input NimbleEditPoolInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_get_all_pool_details

NimblePoolsList device_type2_get_all_pool_details(system_id)

Get all pools details by Nimble / Alletra 6K

Get all pools details by Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_pools_list import NimblePoolsList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "id eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter pools by Key. (optional)
    sort = "name desc" # str | oData query to sort pools resource by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all pools details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_pool_details(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_all_pool_details: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all pools details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_pool_details(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_all_pool_details: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter pools by Key. [optional]
sort str oData query to sort pools resource by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimblePoolsList

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage group object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_get_pool_capacity_history

PoolCapacityHistory device_type2_get_pool_capacity_history(system_id, storage_pool_id)

Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.pool_capacity_history import PoolCapacityHistory
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of storage pool. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)
    range = "startTime eq 1605063600 and endTime eq 1605186000" # str | range will define start and end time in which query has to be made. (optional)
    time_interval_min = 60 # int | It defines granularity in minutes. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_capacity_history(system_id, storage_pool_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_capacity_history: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_capacity_history(system_id, storage_pool_id, select=select, range=range, time_interval_min=time_interval_min)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_capacity_history: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of storage pool. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]
range str range will define start and end time in which query has to be made. [optional]
time_interval_min int It defines granularity in minutes. [optional]

Return type

PoolCapacityHistory

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_get_pool_detail_by_id

NimblePoolDetailsWithRequestUri device_type2_get_pool_detail_by_id(system_id, storage_pool_id)

Get details of Nimble / Alletra 6K pool identified by {storagePoolId}

Get details of Nimble / Alletra 6K pool identified by {storagePoolId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_pool_details_with_request_uri import NimblePoolDetailsWithRequestUri
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of pool. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of Nimble / Alletra 6K pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_detail_by_id(system_id, storage_pool_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_detail_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of Nimble / Alletra 6K pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_detail_by_id(system_id, storage_pool_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_detail_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of pool. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimblePoolDetailsWithRequestUri

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_get_pool_performance_history

StoragePoolPerformanceHistory device_type2_get_pool_performance_history(system_id, storage_pool_id)

Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.storage_pool_performance_history import StoragePoolPerformanceHistory
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of storage pool. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)
    range = "startTime eq 1605063600 and endTime eq 1605186000" # str | range will define start and end time in which query has to be made. (optional)
    time_interval_min = 60 # int | It defines granularity in minutes. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_performance_history(system_id, storage_pool_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_performance_history: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_performance_history(system_id, storage_pool_id, select=select, range=range, time_interval_min=time_interval_min)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_performance_history: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of storage pool. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]
range str range will define start and end time in which query has to be made. [optional]
time_interval_min int It defines granularity in minutes. [optional]

Return type

StoragePoolPerformanceHistory

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_get_pool_performance_statistics

StoragePoolPerformance device_type2_get_pool_performance_statistics(system_id, storage_pool_id)

Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.storage_pool_performance import StoragePoolPerformance
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of storage pool. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_performance_statistics(system_id, storage_pool_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_performance_statistics: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}
        api_response = api_instance.device_type2_get_pool_performance_statistics(system_id, storage_pool_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_get_pool_performance_statistics: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of storage pool. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

StoragePoolPerformance

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_merge_pool_by_id

TaskResponse device_type2_merge_pool_by_id(system_id, storage_pool_id, nimble_merge_pool_input)

Merge pool identified by {storagePoolId} from Nimble / Alletra 6K

Merge pool identified by {storagePoolId} from Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_merge_pool_input import NimbleMergePoolInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of pool. A 42 digit hexadecimal number.
    nimble_merge_pool_input = NimbleMergePoolInput(
        force=False,
        target_pool_id="2a0df0fe6f7dc7bb16000000000000000000004801",
    ) # NimbleMergePoolInput | 

    # example passing only required values which don't have defaults set
    try:
        # Merge pool identified by {storagePoolId} from Nimble / Alletra 6K
        api_response = api_instance.device_type2_merge_pool_by_id(system_id, storage_pool_id, nimble_merge_pool_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_merge_pool_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of pool. A 42 digit hexadecimal number.
nimble_merge_pool_input NimbleMergePoolInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

device_type2_remove_pool_by_id

TaskResponse device_type2_remove_pool_by_id(system_id, storage_pool_id)

Delete pool identified by {storagePoolId} from Nimble / Alletra 6K

Delete pool identified by {storagePoolId} from Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    storage_pool_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of pool. A 42 digit hexadecimal number.

    # example passing only required values which don't have defaults set
    try:
        # Delete pool identified by {storagePoolId} from Nimble / Alletra 6K
        api_response = api_instance.device_type2_remove_pool_by_id(system_id, storage_pool_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->device_type2_remove_pool_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
storage_pool_id str Identifier of pool. A 42 digit hexadecimal number.

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

storage_pool_volumes_list

FleetVolumesList storage_pool_volumes_list(system_id, id)

Get all volumes for storage-pool identified by {id}

Get all volumes for storage-pool identified by {id}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_volumes_list import FleetVolumesList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "147c439db3ecb34d1ccccc932d14fd60" # str | Identifier of pool. A 32 digit number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all volumes for storage-pool identified by {id}
        api_response = api_instance.storage_pool_volumes_list(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pool_volumes_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all volumes for storage-pool identified by {id}
        api_response = api_instance.storage_pool_volumes_list(system_id, id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pool_volumes_list: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str Identifier of pool. A 32 digit number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetVolumesList

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

storage_pools_get_by_id

FleetPoolDetails storage_pools_get_by_id(system_id, id)

Get details of storage pools identified by {id}

Get details of storage pools identified by {id}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_pool_details import FleetPoolDetails
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "147c439db3ecb34d1ccccc932d14fd60" # str | Identifier of pool. A 32 digit number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of storage pools identified by {id}
        api_response = api_instance.storage_pools_get_by_id(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pools_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of storage pools identified by {id}
        api_response = api_instance.storage_pools_get_by_id(system_id, id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pools_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str Identifier of pool. A 32 digit number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetPoolDetails

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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

storage_pools_list

StoragePoolsFleetSummaryList storage_pools_list(system_id)

Get all storage pools for a device {systemId}

Get all storage pools for a device {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import storage_pools_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.storage_pools_fleet_summary_list import StoragePoolsFleetSummaryList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = storage_pools_api.StoragePoolsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq CPG_1" # str | oData query to filter pools by Key. (optional)
    sort = "name desc" # str | oData query to sort pools by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all storage pools for a device {systemId}
        api_response = api_instance.storage_pools_list(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pools_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all storage pools for a device {systemId}
        api_response = api_instance.storage_pools_list(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling StoragePoolsApi->storage_pools_list: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter pools by Key. [optional]
sort str oData query to sort pools by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

StoragePoolsFleetSummaryList

Authorization

JWTAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

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