List Virtual Storage (Detail)¶
Overview¶
Lists all virtual storages in a tenant with details
Classification¶
- List
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v1.0/{tenant_id}/virtual_storages/detail
HTTP Request Body¶
- none
Response¶
HTTP Response Header¶
HTTP Response Body¶
Response Parameter¶
Parameter | Type | Description | Note |
---|---|---|---|
api_error_message | String | Error message in API error case.This property may not appear if there is no error. | |
id | String | Virtual Storage ID (UUID) | |
network_id | String | Network ID (UUID) | |
subnet_id | String | Subnet ID (UUID) | |
ip_addr_pool | AddressPool | IP address pool for the virtual storage | |
host_routes | List of HostRoute | Static routes for the virtual storage | |
volume_type_id | String | Volume type id (UUID) | |
name | String | Name of the virtual storage | Must be unique by tenant |
description | String | Description of the virtual storage | |
status | String | Virtual Storage status | |
created_at | DateTime | Creation timestamp for the virtual storage | |
updated_at | DateTime | Update timestamp for the virtual storage | |
error_message | String | Error message for the virtual storage |
Sample API Request and Response¶
Sample API Request¶
curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/7dea34ac34a14d04b0accbfe793c74af/virtual_storages/detail -H 'Content-type: application/json' -H 'Accept: appli
cation/json' -H 'X-Auth-Token: 5eab07447de3461caba1cc54b16899e9'
Sample API Response¶
HTTP/1.1 200 OK
Date: Thu, 21 Apr 2016 08:12:07 GMT
Content-Type: application/json
Content-Length: 6202
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1b9fa6d6abb9d10f18ded47d8ed8dfb66c26a731db8057c38043b5bb58d052398; Path=/
{
"virtual_storages": [
{
"id": "aebd693e-457b-4344-9d0c-7a3428831189",
"network_id": "f3be1d85-63ad-4542-97ba-661550dad235",
"subnet_id": "f8283b8f-ae3a-44db-9303-f499bafaacbd",
"ip_addr_pool": {
"start": "192.168.1.51",
"end": "192.168.1.54"
},
"host_routes": [
],
"volume_type_id": "6328d234-7939-4d61-9216-736de66d15f9",
"name": "vs-storage-nw01-subnet01",
"description": "vs-storage-nw01-subnet01",
"status": "available",
"created_at": "2016-02-17T08:57:13+0000",
"updated_at": "",
"error_message": ""
},
{
"id": "98ac7596-0d01-4636-93e3-a1013f42a9c3",
"network_id": "e2f7465d-da00-490e-897f-a7a00cb0ac8f",
"subnet_id": "8e90b6c5-1e68-4227-b720-03f779fba6ee",
"ip_addr_pool": {
"start": "192.168.10.10",
"end": "192.168.10.20"
},
"host_routes": [
],
"volume_type_id": "bf33db2a-d13e-11e5-8949-005056ab5d30",
"name": "nttc-test-virtual_storage1459160036-79",
"description": "",
"status": "available",
"created_at": "2016-03-28T10:14:59+0000",
"updated_at": "",
"error_message": ""
}
]
}