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. | |
| 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 | |
| smb_properties | SMB Properties | SMB properties for the virtual storage and its volumes | Available for standard_smb_na volume_type. |
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: Mon, 01 Aug 2022 07:41:22 GMT
Content-Type: application/json
Content-Length: 2390
Connection: keep-alive
ECL-Transaction-ID: cd8eb573-9a42-4264-85c5-6ae32d1e5c93
Set-Cookie: TS0183560f=01cce65ce19252652dd957158d462c33ce253e792928dd43c4337b865b516b45aa253bc80b3fa56c46d6eeae751d4c098fe08c7471; Path=/
{
"api_error_message": "",
"virtual_storages": [
{
"created_at": "2016-08-31T03:47:56+0000",
"description": "",
"error_message": "",
"host_routes": [],
"id": "94514162-bcf3-4d3a-a142-a5a173054e27",
"ip_addr_pool": {
"end": "192.168.101.110",
"start": "192.168.101.101"
},
"name": "PRE-StoragePlane",
"network_id": "33a7680e-366e-49a4-a2aa-8bfdc3245f90",
"status": "available",
"subnet_id": "49abb4ba-6336-488a-8e45-0f6a531ef2b7",
"updated_at": "2016-12-07T08:48:41+0000",
"volume_type_id": "bf33db2a-d13e-11e5-8949-005056ab5d30"
},
{
"created_at": "2017-03-03T08:21:14+0000",
"description": "",
"error_message": "",
"host_routes": [],
"id": "18125408-f741-48d4-8b6a-1a880f0cb5b9",
"ip_addr_pool": {
"end": "10.161.18.202",
"start": "10.161.18.201"
},
"name": "std-st-storage",
"network_id": "d48c6fb1-c239-47ed-9245-c97f2d14ead2",
"status": "available",
"subnet_id": "67766974-7e7e-4169-988a-1c84e4548289",
"updated_at": null,
"volume_type_id": "704db6e5-8a93-41a5-850d-405913600341"
},
{
"created_at": "2018-03-06T02:32:58+0000",
"description": "",
"error_message": "",
"host_routes": [
{
"destination": "0.0.0.0/0",
"nexthop": "10.21.100.1"
}
],
"id": "643bb1d3-904b-4d0f-94fc-951879222ae9",
"ip_addr_pool": {
"end": "10.21.100.120",
"start": "10.21.100.100"
},
"name": "iscsi-vs01",
"network_id": "05a91d08-b404-4cbe-89cc-e547ceb848f4",
"status": "available",
"subnet_id": "ef8baecc-31b4-4e85-8c5d-8b2a4aab4be3",
"updated_at": "2022-02-03T06:59:05+0000",
"volume_type_id": "6328d234-7939-4d61-9216-736de66d15f9"
},
{
"created_at": "2022-07-14T05:18:32+0000",
"description": "smb-vs01",
"error_message": "",
"host_routes": [],
"id": "ea2d35d9-b740-4720-890e-8a2bda56075f",
"ip_addr_pool": {
"end": "192.168.0.20",
"start": "192.168.0.11"
},
"name": "smb-vs01",
"network_id": "463a9867-cbcd-4cba-ba96-027df5ef4988",
"smb_properties": {
"users": [
{
"password": "********",
"username": "testuser"
}
],
"workgroup": "WORKGROUP2"
},
"status": "available",
"subnet_id": "d24e777a-89af-4560-93a0-f82544185297",
"updated_at": "2022-07-21T08:29:39+0000",
"volume_type_id": "a882ade4-9f8e-4aad-8b92-007d17e8887f"
}
]
}