Create a storage pool

Creates a storage pool.

Request

Security

Table 1. Roles capable of executing the Create Storage Pool API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/createStoragePool.adm HTTP/1.1 Host:{manager.dsnet} name={name}&width={width}&deviceIds={deviceId1}&deviceIds={deviceId2}&deviceIds={deviceId3}

Curl method

Edit online


curl -u {admin}:{password} 
     -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/createStoragePool.adm“ 
     -d ”name={name}&width={width}
                    &deviceIds={deviceId1}
                    &deviceIds={deviceId2}
                    &deviceIds={deviceId3}“

Parameters

Edit online

Table 2. Request Parameters for Create Storage Pool (createStoragePool) API method
Parameter	Type	Usage	Default	Description
name	String	Required		Unique name of new storage pool.
width	Integer	Required		Width of storage pool.
partial	Boolean	Optional	false	Set to true if you are planning to create a storage pool with some devices temporarily missing. When true, the number of device IDs that are passed in (by using the deviceIds parameter) does not need to equal the width of the storage pool.
deviceIds	Set [{deviceId}]	Required		Slicestor device IDs to be used in storage pool. Multiple device IDs must be passed to match the width. Devices must not be already in storage pools.
storageEngine	String	packed		Either "zone", "packed" or "file" - indicates whether the storage pool should use zone storage, packed storage or file storage. Zone - Use Zone storage as the internal slice storage format across this storage pool. Packed - Use packed storage as the internal slice storage format across this storage pool. File - Use file storage as the internal slice storage format across this storage pool. The packedStorageEnabled flag is no longer valid and is ignored if set.
accessEnabled	Boolean	Optional	false	Flag that should be set to true if the embedded Accesser service should be enabled on the Storage Pool
protocolType	String	Required	S3	The protocol type to set for the embedded Accesser service
accessServicePorts	Map	Optional		The complete set of access service ports (the ports on which the embedded Accesser service will be listening). For example: accessServicePorts[http/s]=8080
s3VirtualHostSuffix	String	Optional		S3 Virtual Host Suffix
staticWebsiteVirtualHostSuffix	String	Optional		If Static Website Hosting is wanted, specify the Static Website Virtual Host Suffix. Static Website Hosting must be enabled on one or more vaults. Vaults must have DNS-compliant names.
additionalSubjectAltNames	String	Optional		Additional subject alternative names for CSR
regionId	Long	Optional		A region ID to associate with this Storage Pool
defaultVaultIndexFormat	String	Optional		The vault index format to be used by default when creating a vault on this storage pool. Valid values are index2, and index4. When nothing is passed, the value is the system default that was set in the configureNameIndexFormat API method.

Response

Edit online

Returns success or failure status. On success, returns the ID of the new storage pool.

JSON response example

Edit online

{
  ”responseStatus“:”ok“,
  ”responseHeader“:{
    ”status“:”ok“,
    ”now“:{milliseconds from the UNIX epoch},
    ”requestId“:”Uxn0nMCoDkMAAENvDKUAAADJ“
  },
  ”responseData“:{
    ”id“:9
  },

}

Parameters

Edit online

Table 3. Response Parameters for Create Storage Pool (createStoragePool) API method
Parameter	Type	Description
id	Long	ID of the new storage pool.