List Snapshot (Detail)¶
Overview¶
Lists all snapshots in a tenant with details Lists all snapshots in a volume with details
注釈
Snapshots are available only for Block Storage Volumes.
Classification¶
List
Synchronous / Asynchronous¶
Synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{api_endpoint}/v1.0/{tenant_id}/snapshots/detail
{api_endpoint}/v1.0/{tenant_id}/snapshots/detail?volume_id={volume_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/5846e9724f84439c9b44d7d754a70b96/snapshots/detail -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 9b2641e7460b4a5ebae3e9ce0ec472a7'
curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/5846e9724f84439c9b44d7d754a70b96/snapshots/detail?volume_id=6cd24c70-f78a-4da6-a308-9a1d97687d0c -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 1ef05bb777ac430c9ed975bc89f0e31e'
Sample API Response¶
HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 08:03:51 GMT
Server: Apache
Transfer-Encoding: chunked
Content-Type: application/json
{"api_error_message":"","snapshots":[{"id":"09292c3d-f179-4377-9412-b2ef65460c39","status":"available","name":"snapshot01","description":"","usage":0,"volume_id":"6cd24c70-f78a-4da6-a308-9a1d97687d0c","created_at":"2017-01-25T07:12:03+0000","updated_at":null,"deleted_at":null,"error_message":"","snapshot_type_id":"a1c59e22-94d3-11e6-8f3b-080027aeede7","delete_reason":""}]}