Show Volume

Overview

Shows a volume

Classification

• Show

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

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

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.
throughput	String	Throughput value reserved for the volume	Available for pre_nfs_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.
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	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

Block Storage (volume_type=piops_iscsi_na)

Sample API Request

curl -s -i -X GET https://storage-jp1-ecl.api.ntt.com/v1.0/49dec55d78d446dabfe6ecd8858133f4/volumes/888e362e-7732-44a2-8e46-a623185b19c0 -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:18:40 GMT
Content-Type: application/json
Content-Length: 636
Connection: keep-alive
ECL-Transaction-ID: 263b9dc0-06b3-4c60-8cfe-7303f6b23429
Set-Cookie: TS0183560f=01cce65ce1252b7c17e41de02b3b47d8c62614ee7727c84e93375cb68b24ad8b2b0d1a5653ea862eb2af4e7cdac6ab7be78e0cb90d; Path=/

{
    "api_error_message": "",
    "volume": {
        "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
    }
}

File Storage Premium (volume_type=pre_nfs_na)

Sample API Request

curl -s -i -X GET https://storage-jp1-ecl.api.ntt.com/v1.0/49dec55d78d446dabfe6ecd8858133f4/volumes/d17d4a08-aef3-412b-802d-329a7dc38899 -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:19:10 GMT
Content-Type: application/json
Content-Length: 464
Connection: keep-alive
ECL-Transaction-ID: 607f8a39-195e-4352-9510-ddcaa5dc1e6e
Set-Cookie: TS0183560f=01cce65ce12f8542846029b77c112a4960ff87dee803013502cbd36e4342db91890f319df0ca5d3dfa8f0cc190bed1bdf10a72fae1; Path=/

{
    "api_error_message": "",
    "volume": {
        "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
    }
}

File Storage Standard NFS (volume_type=standard_nfs_na)

Sample API Request

curl -s -i -X GET https://storage-jp1-ecl.api.ntt.com/v1.0/49dec55d78d446dabfe6ecd8858133f4/volumes/dda527a0-f393-4142-b59a-ffd228bbca12 -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:19:30 GMT
Content-Type: application/json
Content-Length: 406
Connection: keep-alive
ECL-Transaction-ID: c0e880f1-40f6-4737-a985-a63c95d78d87
Set-Cookie: TS0183560f=01cce65ce159f8e99749384b438a66cef48e90aa7ee353ea33ec6be730c6d2e89d053070a0f3de78617ffca5690c748127b8a00ad3; Path=/

{
    "api_error_message": "",
    "volume": {
        "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": false
    }
}

File Storage Standard SMB (volume_type=standard_smb_na)

Sample API Request

curl -s -i -X GET https://storage-jp1-ecl.api.ntt.com/v1.0/49dec55d78d446dabfe6ecd8858133f4/volumes/5c68dee7-ac29-450a-aef3-8c556c6a46ee -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:19:49 GMT
Content-Type: application/json
Content-Length: 506
Connection: keep-alive
ECL-Transaction-ID: 086d33a6-d9f7-4956-a37b-e2766fb27db3
Set-Cookie: TS0183560f=01cce65ce1747ebbdcf57257c98abb002139177fa1b8175712257e75dafaa7112bec1f02e4cba4dc81393e26475773fa5ffd534a39; Path=/

{
    "api_error_message": "",
    "volume": {
        "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": true
    }
}

目次

• 1. What is SDPF Storage API
  • 1.1. Getting Started
• 2. Smart Data Platform Storage API List
  • 2.1. API Versions
  • 2.2. Availability Zones
  • 2.3. Volume Types
  • 2.4. Virtual Storage
  • 2.5. Volume
  • 2.6. Snapshot
• 3. Smart Data Platform Storage API DataType List
  • 3.1. Version
  • 3.2. Availability Zone
  • 3.3. Volume Type
  • 3.4. Virtual Storage
  • 3.5. AddressPool
  • 3.6. HostRoute
  • 3.7. Volume
  • 3.8. SMB Properties
  • 3.9. SMB User
  • 3.10. Snapshot
• 4. Smart Data Platform Storage API State Transition
  • 4.1. VirtualStorage
  • 4.2. Volume
  • 4.3. Snapshot
• 5. Revision History

---

List Volume (Detail)

Create Volume