Changing the volume settings

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/volumes/object-ID

Request message

Object ID

Specify the id value obtained by getting information about volumes.

Attribute	Type	Description
id	int	(Required) Volume ID

Query parameters

None.

Body

Only the specified attributes are changed.

The following is an example of changing the nickname of a volume:

{
  "nickname": "REST_API_10GVolume"
}

The following is an example of disabling the value set for the capacity saving (deduplication and compression) of a volume:

{
  "savingSetting": "DISABLE"
}

Attribute	Type	Description
nickname	string	(Optional) Specify a new nickname of up to 32 characters. You can use alphanumeric characters (0 through 9, A through Z, a through z), space characters, and the following symbols: Exclamation mark (!), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation mark ('), left parenthesis ((), right parenthesis ()), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), equal sign (=), at sign (@), left square bracket ([), back slash (\), right square bracket (]), caret (^), underscore (_), grave accent mark (`), left curly bracket ({), right curly bracket (}), tilde (~) This attribute is case-sensitive. You can use a space character between characters, but you cannot use it at the beginning or end of the nickname. You cannot use a hyphen (-) at the beginning of the name. If you specify this attribute, do not specify savingSetting.
savingSetting	string	(Optional) Settings for the capacity saving (deduplication and compression) DEDUPLICATION_AND_COMPRESSION: Deduplication and compression is enabled. Compression is enabled when you enable deduplication. COMPRESSION: The capacity saving (compression) is enabled. DISABLE: No settings are specified. If you specify this attribute, it might take time to complete. For details on the capacity saving function, see the Provisioning Guide. If you specify this attribute, do not specify nickname.
compressionAcceleration	boolean	(Optional) Settings for the capacity saving function with compression acceleration true: Enabled false: Disabled You can specify this attribute for VSP E1090 and VSP E1090H storage systems only. If this attribute is omitted, when the value of the savingSetting attribute is changed from DISABLE to a different value, the storage system automatically sets a value for this attribute. If the capacity saving function with compression acceleration can be used: true If the capacity saving function with compression acceleration cannot be used: false If DISABLE is specified for the savingSetting attribute, the value of this parameter is ignored. If you specify this attribute, do not specify nickname.

Response message

Body

• If you changed the volume nickname:

  Attribute	Type	Description
  affectedResources	string[]	List of URLs for referencing information about the changed volume
  operationDetails	object[]	Details about the changed volume For details, see the description of the operationDetails attribute of the commandStatus object.

• If you changed the settings for the capacity saving (deduplication and compression):

  Attribute	Type	Description
  statusResource	string	URL for referencing information about the changed volume

Note:

Run the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/volumes/100