Overview
Error Handling

Methods

API Documentation (API Version v1)

Storage/Block/Cluster/

DESCRIPTION

Block storage clusters are available in specific zones, and this method offers information on the availability for a cluster. Block storage volumes must be created in the same zone as the instance it will be attached to.

list

URL:

https://api.stormondemand.com/v1/Storage/Block/Cluster/list

Description:

Get a paginated list of block storage clusters, including the zone that the cluster is in.

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
idA valid id number (a positive integer).
regionAn associative array containing the values:
 
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.
zoneAvailabilityAn array of a valid id number (a positive integer).
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types