Storage Pool:Get Virtual Arrays

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Get Virtual Arrays

GET /vdc/data-services/varrays

Gets a list of storage pools from the local VDC.

Query Parameters

vdc-id	virtual data center identifier for which list of storage poold is to be retrieved

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR

Response Body

Storage pool details for the given virtual data center identifier

Field	Description	Type	Notes
varrays
varray			0-* Elements
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

Examples

Request

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

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

Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<varrays>
    <varray>
        <id>urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804</id>
        <name>CommodityvPool</name>
        <isProtected>false</isProtected>
        <isColdStorageEnabled>false</isColdStorageEnabled>
    </varray>
</varrays>

Request

GET https://192.168.0.0:4443/vdc/data-services/varrays.json

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

Response

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

{
    "varray": [
        {
            "id": "urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804",
            "name": "CommodityvPool",
            "isProtected": false,
            "isColdStorageEnabled": "false"
        }
    ]
}