• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Snapshots
  6. Querying Snapshot Information

Querying Snapshot Information

Function Description

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

URI

  • URI format

    GET /v2/{tenant_id}/os-snapshots/{snapshot_id}

    GET /v2.1/{tenant_id}/os-snapshots/{snapshot_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    tenant_id

    Yes

    Specifies the tenant or project ID.

    snapshot_id

    Yes

    Specifies the volume snapshot ID.

Request

This interface will become invalid from micro version 2.36. Since this version, the system will return error 404 when you invoke this interface. Using the corresponding storage service interface is recommended.

Response

Parameter

Type

Mandatory

Description

id

String

Yes

Specifies the disk snapshot ID in UUID format.

status

String

Yes

Specifies the volume snapshot status.

displayName

String

No

Specifies the volume snapshot name.

displayDescription

String

No

Specifies the volume snapshot description.

createdAt

String

Yes

Specifies the time when the volume snapshot was created.

volumeId

String

Yes

Specifies the disk ID in UUID format for the snapshot.

size

Int

Yes

Specifies the volume snapshot size.

Request Example

GET /v2/d6c277ba8820452e83df36f33c9fa561/os-snapshots/ b836dc3d-4e10-4ea4-a34c-8f6b0460a583

GET /v2.1/d6c277ba8820452e83df36f33c9fa561/os-snapshots/ b836dc3d-4e10-4ea4-a34c-8f6b0460a583

Response Example

{
    "snapshot": 
        {
            "createdAt": "2016-05-20T16:54:14.981520", 
            "displayDescription": null, 
            "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",  
            "displayName": "test", 
            "size": 1, 
            "status": "creating", 
            "volumeId": "ba5730ea-8621-4ae8-b702-ff0ffc12c209"
        }
}

Returned Values

See General Request Returned Values.