Creating a Volume
POST /volumeIntroduction
Creates a new Volume.
Creating a Volume of the following types is not supported by the ETERNUS RESTful API:
WSV
SDPV
SDV
FTV
You can find the Href of the created Volume in resource_href_list of GET /job/{job_id}.
Tenant users can only create TPV type volumes.
Request Examples
This is an example of creating a Volume (name = sample_vol) of 40 GB in Thin Provisioning Pool ID 0.
$ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume" -d '{"name":"sample_vol","capacity":40960,"tpp_id":0}'This is an example of creating three Destination-Protection-enabled Volumes (name = test_vol) with a capacity of 5 GB on RAID Group ID 10.
$ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume" -d '{"name":"test_vol","capacity":5120,"raidgroup_id":10,"count":3,"is_copy_protection_enabled":"true"}'
Response Examples
{
"job_id": 8192001,
"job_href": "/api/v1/job/8192001"
}
Parameters
REQUEST BODY
| name
(required) |
string Volume name. If "count" is greater than 2, a sequential decimal number is automatically appended to the Volume name. The starting number of the serial number that is added can be specified in "start_number". The number of digits for the serial number that is added can be specified in "number_of_digits". For example, if "name" is "Volume#", "count" is 2, "start_number" is 10, and "number_of_digits" is 3, the names of the created volumes are "Volume#010" and "Volume#011". Input criteria:
|
| capacity
(required) |
integer Volume capacity. The unit is MB. Input criteria:
|
| tpp_id | integer ID of the destination Thin Provisioning Pool. This setting is required if the Volume is created in the Thin Provisioning Pool. Input criteria:
|
| raidgroup_id | integer ID of the destination RAID Group. This setting is required if Volume is created in a RAID Group. Input criteria:
|
| volume_number | integer The Volume Number of the Volume to be created. If omitted, the Volume is automatically numbered. Input criteria:
|
| count | integer Default: 1 The number of volumes to be created. Input criteria:
|
| start_number | integer Default: 0 The starting number of the serial number to be appended to the end of the volume name when multiple volumes are created. Input criteria:
|
| number_of_digits | integer Default: 1 The number of digits for the serial number to be appended to the end of the volume name when multiple volumes are created. Input criteria:
|
| is_data_reduction_disabled | boolean Default: false Data Reduction disable settings. If true, Deduplication and/or Compression is disabled for the data written to the Volume being created. Input criteria:
|
| is_copy_protection_enabled | boolean Default: false Copy destination protection settings. If true, the Volume is not available as a Copy destination. Specify this item if you want to prevent data corruption due to unexpected copying. Input criteria:
|
| is_exc_disabled | boolean Default: false Extreme Cache Pool configuration. If true, Extreme Cache Pool is not used when the created Volume is accessed. Input criteria:
|
| is_thick_provisioned | boolean Default: false Allocation method. If true, physical space is allocated for the volume when it is created. Specify this item if you want to prevent system outages due to physical capacity depletion in the Thin Provisioning Pool. Input criteria:
|
| attention | integer Default: 80 The Used Rate threshold at which the host sense is reported. The unit is %. Input criteria:
|
| is_cm_encryption_enabled | boolean Default: false Encryption via CM. If true, the CM encrypts the data in the Volume. Input criteria:
|
Responses
If successful, the HTTP status code is 202 (Accepted) and the response body is returned.
RESPONSE BODY
| job_id | integer Job ID. |
| job_href | string Resource link of the job. |