Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ Snapshot Management/ Querying Details About an EVS Snapshot
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Details About an EVS Snapshot

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

snapshot_id

Yes

String

The snapshot ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

snapshot

SnapshotDetail object

The snapshot information.
Table 4 SnapshotDetail

Parameter

Type

Description

id

String

The snapshot ID.

name

String

The snapshot name.

Snapshots whose names started with the autobk_snapshot_ prefix are automatically created by the system when backups are created. Such snapshots cannot be deleted or used to roll back data.

description

String

The snapshot description.

created_at

String

The time when the snapshot was created.

Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

updated_at

String

The time when the snapshot was updated.

metadata

Map<String,String>

The snapshot metadata.

volume_id

String

The ID of the snapshot's source disk.

size

String

The snapshot size, in GiB.

status

String

The snapshot status. For details, see EVS Snapshot Status.

os-extended-snapshot-attributes:progress

String

The reserved field.

os-extended-snapshot-attributes:project_id

String

The tenant ID. The tenant ID is the same as the project ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 6 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

GET https://{endpoint}/v2/{project_id}/snapshots/{snapshot_id}

Example Responses

Status code: 200

OK

{
  "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,
  }
}

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Snapshot Management