List Volume (Detail)

Overview

Lists all volumes in a tenant with details

Classification

  • List

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/{tenant_id}/volumes/detail

HTTP Request Header

Format

X-Auth-Token: <token>

HTTP Request Body

  • none

Response

HTTP Response Header

Response Code

Response Codes
Code Description Error? Note
200 OK No Returned in case of success
400 Bad Request Yes  
401 Unauthorized Yes  
500 Internal Server Error Yes  

HTTP Response Body

Response Parameter

Response Parameters
Parameter Type Description Note
api_error_message String Error message in API error case.  
id String Volume's ID (UUID)  
status String Volume status  
name String Name of the volume Must be unique by tenant
description String Description of the volume  
size Integer The size of volume in gigabyte  
iops_per_gb String The provisioned IOPS/GB for volume Available for piops_iscsi_na volume_type.
initiator_iqns Array of String Array of initiator IQN who can access to this volume Available for piops_iscsi_na volume_type.
initiator_secret String Initiator's secret (password) for CHAP auth of iSCSI Available for piops_iscsi_na volume_type.
target_secret String Target's secret (password) for CHAP auth of iSCSI Available for piops_iscsi_na volume_type.
snapshot_ids Array of String Array of Snapshot IDs taken from this volume  
target_ips Array of IPv4 addresses Array of IPv4 addresses of the volume.  
throughput String Throughput value reserved for the volume. Available for pre_nfs_na.
metadata String One or more metadata key and value pairs to associate with the volume. Available for piops_iscsi_na volume_type.
virtual_storage_id String virtual_storage ID (UUID)  
availability_zone String An availability_zone in which the volume belongs to availability_zone=zone-group
created_at DateTime Timestamp of volume creation complete  
updated_at DateTime Timestamp of volume update complete  
error_message String Error message for the volume  
percent_snapshot_reserve_used Integer Usage of available snapshot capacity in percent Available for piops_iscsi_na volume_type.
smb_properties SMB Properties SMB properties for the virtual storage and its volumes Optional (only available for standard_smb_na volume_type)
export_rules List of String Allow list for volumes.Clients from CIDRs listed here can access to volumes Available for pre_nfs_na/standard_nfs_na/standard_smb_na volume_type.
encrypt Boolean Whether the volume is encrypted or not.  

Sample API Request and Response

Sample API Request

curl -s -i -X GET https://storage-jp1-ecl.api.ntt.com/v1.0/49dec55d78d446dabfe6ecd8858133f4/volumes/detail -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 00a42d953f794b63b11785273546d6eb'

Sample API Response

HTTP/1.1 200 OK
Date: Thu, 08 Sep 2022 02:04:51 GMT
Content-Type: application/json
Content-Length: 3165
Connection: keep-alive
ECL-Transaction-ID: 4d65f5e5-ce6c-437c-b809-9346f0c4e9f3
Set-Cookie: TS0183560f=01cce65ce1a9ec9ba16007c59b54b9ea7a812c0b69f3df055fe1e6a4866ff7243eb7c197113f0dc91ab929b48fa8f110b03f055736; Path=/

{
    "api_error_message": "",
    "volumes": [
        {
            "availability_zone": "zone1-groupb",
            "created_at": "2021-04-22T04:36:04+0000",
            "description": "test da yo",
            "error_message": " ",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "1c504e2f-04d9-47b7-bd72-2a0c3a676540",
            "name": "vol20210422-01",
            "size": 1024,
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "192.168.0.100"
            ],
            "updated_at": "2022-02-03T06:50:17+0000",
            "virtual_storage_id": "88b5c056-a4a6-4edd-9bef-791144936a66",
            "encrypt": false
        },
        {
            "availability_zone": "zone1-groupa",
            "created_at": "2022-02-03T05:11:44+0000",
            "description": "test_description2",
            "error_message": "",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "d17d4a08-aef3-412b-802d-329a7dc38899",
            "name": "prevol20220203-01",
            "size": 256,
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "192.168.101.101"
            ],
            "throughput": "50",
            "updated_at": "2022-02-03T06:50:50+0000",
            "virtual_storage_id": "94514162-bcf3-4d3a-a142-a5a173054e27",
            "encrypt": false
        },
        {
            "availability_zone": "zone1-groupb",
            "created_at": "2022-02-24T08:03:35+0000",
            "description": "",
            "error_message": "",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "b22106ae-83c3-46cb-96f3-c0aaddf8c83e",
            "name": "stdvol20220224-01",
            "size": 1024,
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "10.161.18.201"
            ],
            "updated_at": null,
            "virtual_storage_id": "18125408-f741-48d4-8b6a-1a880f0cb5b9",
            "encrypt": true
        },
        {
            "availability_zone": "zone1-groupb",
            "created_at": "2022-05-23T02:45:53+0000",
            "description": "",
            "error_message": "",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "dda527a0-f393-4142-b59a-ffd228bbca12",
            "name": "stdvol20220523-01",
            "size": 1024,
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "10.161.18.201"
            ],
            "updated_at": null,
            "virtual_storage_id": "18125408-f741-48d4-8b6a-1a880f0cb5b9",
            "encrypt": true
        },
        {
            "availability_zone": "zone1-groupa",
            "created_at": "2022-07-15T09:47:53+0000",
            "description": "",
            "error_message": "",
            "id": "888e362e-7732-44a2-8e46-a623185b19c0",
            "initiator_iqns": [
                "iqn.1993-08.org.debian:01:af5bf2af245",
                "iqn.1993-08.org.debian:01:3b674b17c2"
            ],
            "initiator_secret": null,
            "iops_per_gb": "2",
            "metadata": {
                "lun_id": "3"
            },
            "name": "vol-20220715-01",
            "percentage_snapshot_reserve_used": 0,
            "size": 100,
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "10.21.100.100",
                "10.21.100.101"
            ],
            "target_secret": null,
            "updated_at": "2022-09-07T09:35:15+0000",
            "virtual_storage_id": "643bb1d3-904b-4d0f-94fc-951879222ae9",
            "encrypt": false
        },
        {
            "availability_zone": "zone1-groupb",
            "created_at": "2022-07-21T08:20:27+0000",
            "description": "smb-vol01",
            "error_message": "",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "5c68dee7-ac29-450a-aef3-8c556c6a46ee",
            "name": "smb-vol01",
            "size": 1024,
            "smb_properties": {
                "users": [
                    {
                        "password": "********",
                        "username": "testuser"
                    }
                ],
                "workgroup": "WORKGROUP2"
            },
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "192.168.0.11"
            ],
            "updated_at": null,
            "virtual_storage_id": "ea2d35d9-b740-4720-890e-8a2bda56075f",
            "encrypt": false
        },
        {
            "availability_zone": "zone1-groupb",
            "created_at": "2022-07-21T08:20:48+0000",
            "description": "smb-vol02",
            "error_message": "",
            "export_rules": [
                "0.0.0.0/0"
            ],
            "id": "6259d73b-c582-4423-98ee-e119d9f4d019",
            "name": "smb-vol02",
            "size": 1024,
            "smb_properties": {
                "users": [
                    {
                        "password": "********",
                        "username": "testuser"
                    }
                ],
                "workgroup": "WORKGROUP2"
            },
            "snapshot_ids": [],
            "status": "available",
            "target_ips": [
                "192.168.0.11"
            ],
            "updated_at": null,
            "virtual_storage_id": "ea2d35d9-b740-4720-890e-8a2bda56075f",
            "encrypt": false
        }
    ]
}