• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Snapshot
  6. List Snapshots With Details

List Snapshots With Details

Function Description

This interface is used to query detailed information about volume snapshots.

Interface Format

Method

URI

Description

GET

/v3/{project_id}/snapshots/detail

This interface is used to query detailed information about volume snapshots.

Restrictions

N/A

Request Parameter

request filter parameters

Parameter

Type

Mandatory

Description

offset

Int

No

Specifies the offset of the returned results.

limit

Int

No

Specifies the limit of the number of returned results. The value is an integer greater than 0.

name

String

No

Specifies the volume backup name. The value is a string of less than 255 characters.

status

String

No

Specifies the volume snapshot status. The value can be available or error.

volume_id

Uuid

No

Specifies the volume ID corresponding to the volume snapshot.

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 volume snapshot is updated.

Request Example

GET https://volume.localdomain.com:8776/v3/d6c277ba8820452e83df36f33c9fa561/snapshots/detail

Response Example

{
    "snapshots": [
        {
            "status": "available",
            "os-extended-snapshot-attributes:progress": "100%",
            "description": null,
            "created_at": "2013-06-19T07:15:29.000000",
            "metadata": {},
            "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
            "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
            "size": 5,
            "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
            "name": "name_xx2-snap"
        },
        {
            "status": "available",
            "os-extended-snapshot-attributes:progress": "100%",
            "description": null,
            "created_at": "2013-06-19T09:08:08.000000",
            "metadata": {},
            "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
            "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
            "size": 5,
            "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
            "name": "name_xx2-snap"
        }
    ]
}

Error Code

See section Processing Return Code.