Update Virtual Storage¶

Overview¶

Updates properties of a virtual storage

Pre/Post Conditions¶

virtual_storage status must be 'available'

Classification¶

Update

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{api_endpoint}/v1.0/{tenant_id}/virtual_storages/{virtual_storage_id}

HTTP Request Header¶

Format¶

X-Auth-Token: <token>

HTTP Request Body¶

Request Parameter¶

Request Parameter¶
Parameter	Request Type	Type	Description	Required or Optional	Note
name	plain	String	Name of virtual storage	Optional	Must be unique by tenant.
description	plain	String	Description of virtual storage	Optional
ip_addr_pool	plain	AddressPool	IP address pool start/end information	Optional
host_routes	plain	List of HostRoute	Static routes for the virtual storage	Optional
smb_properties	plain	SMB Properties	SMB properties for the virtual storage and its volumes	Optional	Available for standard_smb_na volume_type.

Response¶

HTTP Response Header¶

Response Code¶

Response Codes¶
Code	Description	Error?	Note
202	Accepted	No	Returned in case of success
400	Bad Request	Yes
401	Unauthorized	Yes
409	Tenant is busy	Yes	Returned if one of creation/update/deletion/restore request is already on-going
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	Virtual storage's ID (UUID)
network_id	String	Network ID (UUID)
subnet_id	String	Subnet ID (UUID)
ip_addr_pool	AddressPool	Specifies start/end of IP address pool
host_routes	List of HostRoute	Specifies static route settings for virtual storage
volume_type_id	String	Volume type ID (UUID) for virtual storage
name	String	Name of the volume	Must be unique by tenant
description	String	Description of the volume
status	String	Status of virtual storage
created_at	DateTime	Creation timestamp of virtual storage
updated_at	DateTime	Update timestamp of virtual storage
error_message	String	Error message of 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 PUT https://storage-jp1.ecl.api.ntt.com/v1.0/5846e9724f84439c9b44d7d754a70b96/virtual_storages/3ad2b498-58c5-46f7-8697-1000ee5bf166 -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: b2858796e83743b9b8ca60d64cc5ddb4' -d '{ "virtual_storage": { "description": "Test Description"}}'

Sample API Response¶

HTTP/1.1 202 Accepted
Date: Fri, 27 Jan 2017 04:19:50 GMT
Server: Apache
Transfer-Encoding: chunked
Content-Type: application/json

{
  "api_error_message": "",
  "virtual_storage": {
  "id": "3ad2b498-58c5-46f7-8697-1000ee5bf166",
  "network_id": "417e42e3-ec3c-40ff-a436-f0f2eebc7d7c",
  "subnet_id": "d26219fe-2d37-469f-b3c8-b89df3050dfd",
  "ip_addr_pool": {
    "start": "192.168.10.50",
    "end": "192.168.10.60"
  },
  "host_routes": [
  ],
  "volume_type_id": "6328d234-7939-4d61-9216-736de66d15f9",
  "name": "nttc-test-virtual_storage20170118-054740-985392",
  "description": "Test Description",
  "status": "updating",
  "created_at": "2017-01-18T05:46:51+0000",
  "updated_at": "2017-01-27T04:19:51+0000",
  "error_message": ""
}}

Create Virtual Storage

Delete Virtual Storage