3.7. Volume¶
DATA TYPE¶
Parameters¶
Parameter Name |
Data Type |
Applicable volume_type.name |
Description |
id |
String |
all |
The ID (UUID) for volume. | |
status |
String |
all |
The status of volume. |
name |
String |
all |
The name of volume. |
description |
String |
all |
The description of volume. |
size |
Integer |
all |
The size of volume in GB. |
iops_per_gb |
String |
piops_iscsi_na / piops_iscsi_na2 |
The provisioned IOPS/GB value for volume. |
initiator_iqns |
List of Strings |
piops_iscsi_na / piops_iscsi_na2 |
The initiator IQNs who can accessible to volume. |
initiator_secret |
String |
piops_iscsi_na / piops_iscsi_na2 |
The initiator secret (password) for CHAP authentication for the volume. This value is always null for current service and reserved for future use. |
target_secret |
String |
piops_iscsi_na / piops_iscsi_na2 |
The initiator secret (password) for CHAP authentication for the volume. This value is always null for current service and reserved for future use. |
metadata |
Hash |
piops_iscsi_na / piops_iscsi_na2 |
"lun_id" is iSCSI LUN ID and we can distinguish Volumes in iSCSI initiator view. |
snapshot_ids |
List of Strings |
all |
The list of snapshot IDs for volume. This list is always [] for current service and reserved for future use. |
target_ips |
List of Strings |
all |
The list of target IPv4 addresses for iSCSI access. iSCSI initiators registered its IQN to "initiator_iqns" can login to one of the IPv4 addresses. |
virtual_storage_id |
String |
all |
The virtual storage ID which accommodates the volume. |
availability_zone |
String |
all |
The availability zone which accommodates the volume. |
created_at |
ISO8601 DateTime |
all |
The creation timestamp for volume. |
updated_at |
ISO8601 DateTime |
all |
The update timestamp for volume. |
error_message |
String |
all |
The error message for volume. | |
snapshot_reserve_size |
Integer |
piops_iscsi_na2 |
Capacity for snapshots on this volume in GiB. |
snapshot_reserve_used |
Integer |
piops_iscsi_na2 |
Capacity usage for snapshots on this volume in GiB. |
percentage_snapshot_reserve |
Integer |
piops_iscsi_na2 |
Capacity reserved for snapshots on this volume in percent. |
percentage_snapshot_reserve_used |
Integer |
piops_iscsi_na / piops_iscsi_na2 |
Capacity usage for snapshots on this volume in percent. |
Example¶
## volume_type.name = "piops_iscsi_na"
{
"id" : "13fea5a0-a36f-43e8-92ef-1cf472725dbe",
"status" : "available",
"name" : "vol01",
"description" : null,
"size" : 100,
"iops_per_gb" : "2",
"initiator_iqns" : [
"iqn.1998-01.com.vmware.iscsi:name1",
"iqn.2015-06.com.ntt.iscsi:cl01"
],
"initiator_secret" : null,
"target_secret" : null,
"snapshot_ids" : [],
"target_ips": [ "192.168.0.11", "192.168.0.12"],
"metadata" : { "lun_id": "0" },
"virtual_storage_id" : "90ff9a35-726d-47d6-a048-f080d2c90b57",
"availability_zone" : "zone1-groupa",
"created_at" : "2015-05-17T18:14:34.000000",
"updated_at" : null,
"error_message" : "",
"percentage_snapshot_reserve_used" : 0
}
## volume_type.name = "piops_iscsi_na2"
{
"id" : "13fea5a0-a36f-43e8-92ef-1cf472725dbe",
"status" : "available",
"name" : "vol01",
"description" : null,
"size" : 100,
"iops_per_gb" : "2",
"initiator_iqns" : [
"iqn.1998-01.com.vmware.iscsi:name1",
"iqn.2015-06.com.ntt.iscsi:cl01"
],
"initiator_secret" : null,
"target_secret" : null,
"snapshot_ids" : [],
"target_ips": [ "192.168.0.11", "192.168.0.12"],
"metadata" : { "lun_id": "0" },
"virtual_storage_id" : "90ff9a35-726d-47d6-a048-f080d2c90b57",
"availability_zone" : "zone1-groupa",
"created_at" : "2015-05-17T18:14:34.000000",
"updated_at" : null,
"error_message" : "",
"percentage_snapshot_reserve_used" : 0,
"percentage_snapshot_reserve" : 10,
"snapshot_reserve_size" : 10,
"snapshot_reserve_used" : 0
}