• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V2 Interfaces
  5. Snapshot
  6. Show Snapshot

Show Snapshot

Function Description

This interface is used to query information about a specified volume snapshot.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/snapshots/{snapshot_id}

This interface is used to query information about a specified volume snapshot.

Restrictions

N/A

Request Parameter

N/A

Response Parameter

Parameter

Type

Mandatory

Description

id

Uuid

Yes

Specifies the ID of the volume snapshot.

status

String

Yes

Specifies the status of the volume snapshot.

name

String

No

Specifies the name of the volume snapshot.

description

String

No

Specifies the descriptive information about the volume snapshot.

created_at

String

Yes

Specifies the time when the volume snapshot was created.

metadata

Dict

No

Specifies the metadata of the volume snapshot.

volume_id

Uuid

Yes

Specifies the volume to which the snapshot belongs.

size

Int

Yes

Specifies the size of the volume snapshot.

os-extended-snapshot-attributes:project_id

String

Yes

Specifies the tenant ID.

os-extended-snapshot-attributes:progress

String

Yes

Specifies the progress of the volume snapshot.

updated_at

String

No

Specifies the time when the snapshot was updated.

Request Example

GET /v2/d6c277ba8820452e83df36f33c9fa561/snapshots/2bb856e1-b3d8-4432-a858-09e4ce939389

Response Example

{
    "snapshot": {
        "status": "available",
        "os-extended-snapshot-attributes:progress": "100%",
        "description": "daily backup",
        "created_at": "2013-02-25t04:13:17.000000",
        "metadata": {},
        "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
        "os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
        "size": 1,
        "id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
        "name": "snap-001"
    }
}

Error Code

See section Processing Return Code.