Storage Pool:Create Virtual Array

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Create Virtual Array

POST /vdc/data-services/varrays

Create a storage pool with the specified details.

Required Roles

SYSTEM_ADMIN

Request Payload

<virtual_array_create>
   <name></name>
   <isProtected></isProtected>
   <description></description>
   <isColdStorageEnabled></isColdStorageEnabled>
   <warningAlertAt></warningAlertAt>
   <errorAlertAt></errorAlertAt>
   <criticalAlertAt></criticalAlertAt>
   <numberOfDataBlocks></numberOfDataBlocks>
   <numberOfCodeBlocks></numberOfCodeBlocks>
   <numberOfStorageServerInstances></numberOfStorageServerInstances>
   <label></label>
   <driveTechnology></driveTechnology>
</virtual_array_create>

{
  "name": "",
  "isProtected": "",
  "description": "",
  "isColdStorageEnabled": "",
  "warningAlertAt": "",
  "errorAlertAt": "",
  "criticalAlertAt": "",
  "numberOfDataBlocks": "",
  "numberOfCodeBlocks": "",
  "numberOfStorageServerInstances": "",
  "label": "",
  "driveTechnology": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
virtual_array_create
name	Virtual array name	String
isProtected	s Set to true if varray is protected, false otherwise	Boolean	Valid Values: true false
description	Description	String
isColdStorageEnabled	Is ColdStorage enabled on the virtual array	Boolean	Valid Values: true false
warningAlertAt	Threshold percent at which warning alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
errorAlertAt	Threshold percent at which error alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
criticalAlertAt	Threshold percent at which critical alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
numberOfDataBlocks	Number of data blocks for configurable EC scheme	Integer
numberOfCodeBlocks	Number of code blocks for configurable EC scheme	Integer
numberOfStorageServerInstances	Number of storage server instances for validation of configurable EC scheme	Integer
label	Drive Technology of VArray	String
driveTechnology	Drive Technology of VArray	String

Response Body

Newly created virtual array details.

Field	Description	Type	Notes
varray
id	Storage pool id	String
name	Storage pool name	String
description	Description	String
isColdStorageEnabled	Flag indicating that cold storage encoding is enabled	Boolean	Valid Values: True False
numberOfDataBlocks	Number of Data Blocks in EC Scheme	Integer
numberOfCodeBlocks	Number of Code Blocks in EC Scheme	Integer
warningAlertAt	Threshold percent at which warning alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
errorAlertAt	Threshold percent at which error alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
criticalAlertAt	Threshold percent at which critical alert is raised. Valid values are from -1 to 100. Value of -1 means do not alert	Integer
status	flag for status, -1 for null, 0 ~ 6 for value	Integer
label	Drive technology of VArray	String
driveTechnology		String

Examples

Request

POST https://192.168.0.0:4443/vdc/data-services/varrays HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<virtual_array_create>
   <name>varray_q</name>
   <isProtected>false</isProtected>
   <isColdStorageEnabled>false</isColdStorageEnabled>
   <description>varray desc</description>
</virtual_array_create>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<varray>
    <id>urn:storageos:VirtualArray:9c524c80-44de-4088-af18-343c2cee9a2c</id>
    <name>varray_q</name>
    <isProtected>false</isProtected>
    <isColdStorageEnabled>false</isColdStorageEnabled>
</varray>

Request

POST https://192.168.0.0:4443/vdc/data-services/varrays.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "name": "varray_4",
  "isProtected": "false",
  "isColdStorageEnabled": "false",
  "description": " varray desc 4"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "urn:storageos:VirtualArray:dd751e72-0142-4598-a440-b4f833e93b61",
    "name": "varray_4",
    "isProtected": false,
    "isColdStorageEnabled": "false"
}

Request

cat body.txt

<virtual_array_create>
   <name>varray_q</name>
   <isProtected>false</isProtected>
   <isColdStorageEnabled>false</isColdStorageEnabled>
   <description>varray desc</description>
</virtual_array_create>

curl -H $token -H "Content-Type: application/xml" -X POST --data @body.txt https://$nodeIp:4443/vdc/data-services/varrays

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<varray>
    <id>urn:storageos:VirtualArray:9c524c80-44de-4088-af18-343c2cee9a2c</id>
    <name>varray_q</name>
    <isProtected>false</isProtected>
    <isColdStorageEnabled>false</isColdStorageEnabled>
</varray>