List Volume

Overview

Lists all volumes in a tenant

Classification

  • List

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

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

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)  
name String Name of the volume Must be unique by tenant

Sample API Request and Response

Sample API Request

curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/7dea34ac34a14d04b0accbfe793c74af/volumes -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 018c5ff5318a4269a20c5be0128bcfc1'

Sample API Response

HTTP/1.1 200 OK
Date: Tue, 26 Apr 2016 09:51:20 GMT
Content-Type: application/json
Content-Length: 1397
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1af93b13629d0c9b5e0fe7c90f30ae788f18e94d15f9aaa4d9d7966214595d8ea; Path=/

{
  "api_error_message": "",
  "volumes" : [ {
    "id" : "f5ce88cb-b275-4edf-ac40-82829ac851af",
    "name" : "storage-plane-volume01"
  }, {
    "id" : "94ab429d-f365-4f3a-961e-fa5ad0a2e47c",
    "name" : "nttc-uat-test-volume561458189601-19"
  }, {
    "id" : "6e010126-25b3-4c89-a39e-c202bfbac19b",
    "name" : "nttc-uat-test-volume491459161749-44"
  } ]
}
2.5. Volume
List Volume (Detail)