Show Snapshot¶
Classification¶
Show
Synchronous / Asynchronous¶
Synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{api_endpoint}/v1.0/{tenant_id}/snapshots/{snapshot_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 |
Snapshot's ID (UUID) |
|
status |
String |
Snapshot status |
|
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 |
volume ID (UUID) |
|
snapshot_type_id |
String |
ID (UUID) of snapshot_type |
|
created_at |
DateTime |
Creation timestamp for snapshot |
|
updated_at |
DateTime |
Update timestamp for snapshot |
|
deleted_at |
DateTime |
Delete timestamp for snapshot |
|
error_message |
String |
Error message for snapshot in case of error |
|
delete_reason |
String |
Delete reason why the snapshot automatically deleted |
Sample API Request and Response¶
Sample API Request¶
curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/7dea34ac34a14d04b0accbfe793c74af/snapshots/f5ce88cb-b275-4edf-ac40-82829ac851af -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 018c5ff5318a4269a20c5be0128bcfc1'
Sample API Response¶
HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 07:05:05 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": ""
}
}