Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Virtual Array

GET /vdc/data-services/varrays/{id}

Gets the details for the specified storage pool.

idStorage pool identifier to be retrieved

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Response Body

Storage pool details for the given identifier

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

Examples

Request
GET https://192.168.0.0:4443/vdc/data-services/varrays/urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804  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"?>
<varray>
    <id>urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804</id>
    <name>CommodityvPool</name>
    <isProtected>false</isProtected>
</varray>