Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Update Virtual Array

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

Updates storage pool for the specified identifier.

idStorage pool identifier to be updated

Required Roles

  • SYSTEM_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
virtual_array_update
name Name of virtual array to be updated String
isProtected Set true if varray is protected, false otherwise Boolean Valid Values:
  •  true
  •  false
description Description. If no description found, then "Virtual Array" is used by default 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
status flag for status, -1 for null, 0 ~ 6 for value Integer

Response Body

Updated 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

Examples

Request
PUT https://192.168.0.0:4443/vdc/data-services/varrays/urn:storageos:VirtualArray:88543171-9a1b-4133-ac71-d93990d3bebd:

Content-Type: application/xml
X-SDS-AUTH-TOKEN=BAAcRGtUUmNOZHNpbitMaEVhZUhhdWtad1J3WDRRPQMAUAQADTEzNzk1NDIwMjQ4MzACAAEABQA5dXJuOnN0b3JhZ2VvczpUb2tlbjoxYmVhNGJiMy04M2MwLTRlOGItODc4Ni1iYWYxYmM4NTZkNTY6AgAC0A8=

<virtual_array_update>
   <name>CommodityvPool</name>
   <isProtected>true</isProtected>
   <description>desc</description>
</virtual_array_update>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<varray>
    <id>urn:storageos:VirtualArray:82cf257b-0782-433c-92ca-2ee6161b917e</id>
    <name>CommodityvPool</name>
    <isProtected>true</isProtected>
</varray>