Create Snapshot¶

Overview¶

Creates a snapshot on specified volume

注釈

Snapshots are available only for Block Storage Volumes.

Pre/Post Conditions¶

volume_type must be 'piops_iscsi_na'
volume status must be 'available'

Classification¶

Create

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

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

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 snapshot	Required	Must be unique by tenant
description	plain	String	Description of snapshot	Optional
volume_id	plain	String	ID (UUID) of parent volume	Required

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
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	Snapshot's ID (UUID)
status	String	Status of snapshot
name	String	Name of snapshot	Must be unique by tenant
description	String	Description of snapshot
usage	Integer	The usage of snapshot in byte
volume_id	String	ID (UUID) of parent volume
snapshot_type_id	String	ID (UUID) of snapshot_type
created_at	DateTime	Timestamp of snapshot creation complete
updated_at	DateTime	Timestamp of snapshot update complete
deleted_at	DateTime	Timestamp of snapshot deletion complete
error_message	String	Error message for snapshot
delete_reason	String	Deletion reason of snapshot

Sample API Request and Response¶

Sample API Request¶

curl -s -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 9b2641e7460b4a5ebae3e9ce0ec472a7' -X POST -d '{"snapshot" : { "volume_id": "6cd24c70-f78a-4da6-a308-9a1d97687d0c", "name": "snapshot01"}}' https://storage-jp1.ecl.api.ntt.com/v1.0/5846e9724f84439c9b44d7d754a70b96/snapshots

Sample API Response¶

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 07:01:01 GMT
Server: Apache
Transfer-Encoding: chunked
Content-Type: application/json

{
    "api_error_message": "",
    "snapshot": {
        "id": "6d122618-0bc1-4897-b909-891adb0f5b26",
        "status": "available",
        "name": "snapshot01",
        "description": "",
        "usage": 0,
        "volume_id": "6cd24c70-f78a-4da6-a308-9a1d97687d0c",
        "snapshot_type_id": "a1c59e22-94d3-11e6-8f3b-080027aeede7",
        "created_at": "2017-01-25T07:01:03+0000",
        "updated_at": null,
        "deleted_at": null,
        "error_message": "",
        "delete_reason": ""
    }
}

Show Snapshot

Update Snapshot