Show Virtual Storage¶
Overview¶
Shows specified virtual storage information
Classification¶
- Show
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v1.0/{tenant_id}/virtual_storages/{virtual_storage_id}
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/98ac7596-0d01-4636-93e3-a1013f42a9c3 -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 684231fb735c4eac80cf37ee087c6630'
Sample API Response¶
HTTP/1.1 200 OK
Date: Thu, 21 Apr 2016 09:13:31 GMT
Content-Type: application/json
Content-Length: 537
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1f6667c2712cb0b479e92c4465a9ac880f0850c20ae17a8f346c0f157c3050762; Path=/
{
"api_error_message": "",
"virtual_storage":
{
"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": ""
}
}