• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Snapshot
  6. Querying Details About an EVS Snapshot

Querying Details About an EVS Snapshot

Function

This API is used to query details about an EVS snapshot.

URI

  • URI format

    GET /v2/{project_id}/snapshots/{snapshot_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    snapshot_id

    Yes

    Specifies the snapshot ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    snapshot

    map

    Specifies the snapshot information.

    id

    string

    Specifies the ID of the EVS snapshot.

    status

    string

    Specifies the snapshot status. For details, see EVS Snapshot Status.

    name

    string

    Specifies the name of the EVS snapshot.

    description

    string

    Specifies the description of the EVS snapshot.

    created_at

    string

    Specifies the time when the EVS snapshot was created.

    update_at

    string

    Specifies the time when the EVS snapshot was updated.

    metadata

    map

    Specifies the metadata of the EVS snapshot.

    If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server.

    volume_id

    string

    Specifies the disk to which the snapshot belongs.

    size

    int

    Specifies the size of the EVS snapshot.

    os-extended-snapshot-attributes:project_id

    string

    Specifies the tenant ID.

    os-extended-snapshot-attributes:progress

    string

    Specifies the snapshot creation progress.

  • Example response
    {
        "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",
            "updated_at": null
    
        }
    }

    or

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:

    {
        "itemNotFound": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.