Shrinking a pool

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request removes an LDEV from a pool to decrease the pool capacity. Note that you cannot remove all LDEVs from the pool.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/pools/object-ID/actions/shrink/invoke

Request message

Object ID
Specify the value of poolId that was obtained by the processing to get information about pools.

Attribute

Type

Description

poolId

int

(Required) Pool number

Query parameters
None.
Body
{
  "parameters": {
    "ldevIds": [101,102]
  }
}

Attribute

Type

Description

ldevIds

int[]

(Optional) Specify the LDEV number with a decimal (base 10) number.

You can specify up to 64 numbers. This attribute cannot be specified along with the startLdevId and endLdevId attribute.

startLdevId

int

(Optional) First LDEV number when specifying a range of consecutive LDEV numbers.

If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be smaller than that of endLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

endLdevId

int

(Optional) Last LDEV number when specifying a range of consecutive LDEVs.

If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be greater than that of startLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the description on job objects.

Attribute

Description

affectedResources

URL of the shrunk pool

Action template

GET base-URL/v1/objects/pools/object-ID/actions/shrink

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The specified action cannot be run on the specified pool because there is only one LDEV in the pool.

Coding example

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/shrink

To run the request after getting an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/shrink/invoke