Help Center/ Elastic Volume Service/ API Reference/ API/ Snapshot Management/ Querying Details About EVS Snapshots
Updated on 2024-02-27 GMT+08:00

Querying Details About EVS Snapshots

Function

This API is used to query details about EVS snapshots.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cloudsnapshots/detail

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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

The offset. This parameter is used when snapshots are queried by page and is used together with the limit parameter. For example, there are a total of 30 snapshots. If you set offset to 11 and limit to 10, the query starts from the twelfth snapshot, and a maximum of 10 snapshots can be queried at a time.

limit

No

Integer

The maximum number of query results that can be returned. The value must be an integer greater than 0. The default value is 1000.

name

No

String

The snapshot name. You can enter up to 64 characters.

status

No

String

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

volume_id

No

String

The ID of the snapshot's source disk.

availability_zone

No

String

The AZ of the snapshot's source disk.

id

No

String

The snapshot ID for filtering. Multiple IDs can be transferred for filtering. The format is id=id1&id=id2&id=id3.

dedicated_storage_name

No

String

The dedicated storage pool name.

dedicated_storage_id

No

String

The dedicated storage pool ID.

service_type

No

String

The service type. The value can be EVS, DSS, or DESS.

enterprise_project_id

No

String

The enterprise project ID, which is used for filtering. If all_granted_eps is transferred, the disks in all enterprise projects that are within the permission scope will be queried.

NOTE:

For details about how to obtain enterprise project IDs and enterprise project features, see Overview.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

count

Integer

The total number of snapshots. This value is not affected by the limit parameter.

snapshots

Array of SnapshotList objects

The snapshot information.

snapshots_links

Array of Link objects

The query position marker in the snapshot list. This field is returned only when limit is specified in the request, and this field indicates that only some snapshots are returned in this query.

Table 5 SnapshotList

Parameter

Type

Description

id

String

The snapshot ID.

status

String

The snapshot status.

name

String

The snapshot name.

description

String

The snapshot description.

created_at

String

The time when the snapshot was created.

updated_at

String

The time when the snapshot was updated.

metadata

Map<String,String>

The snapshot metadata.

volume_id

String

The snapshot's source disk.

size

Integer

The snapshot size.

os-extended-snapshot-attributes:project_id

String

The project ID.

os-extended-snapshot-attributes:progress

String

The snapshot creation progress.

dedicated_storage_id

String

The dedicated storage pool ID.

dedicated_storage_name

String

The dedicated storage pool name.

service_type

String

The service type.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs. For details, seeParameters in the error field.

Table 8 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs. For the error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

  • Querying details of snapshots (The snapshot IDs are c311bb8d-17f1-4e99-aaf9-e132c0391a73 and c7691083-15fa-4045-956c-2bcbfe1b9976. The query starts from the first record. The number of records returned cannot exceed 100.)

    GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?id=c311bb8d-17f1-4e99-aaf9-e132c0391a73&id=c7691083-15fa-4045-956c-2bcbfe1b9976&offset=0&limit=100
  • Querying details of all snapshots of the EVS disk whose ID is f8c7cce6-ec47-43ca-9297-b5604668b08f

    GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?volume_id=f8c7cce6-ec47-43ca-9297-b5604668b08f&service_type=EVS

Example Responses

Status code: 200

OK

{
  "count" : 3,
  "snapshots_links" : [ {
    "href" : "https://{endpoint}/v2/20a68d6b7a124ae2b6b8a22046ee5966/cloudsnapshots/detail?limit=1&marker=fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
    "rel" : "next"
  } ],
  "snapshots" : [ {
    "status" : "available",
    "updated_at" : "2018-06-06T10:58:47.349051",
    "volume_id" : "f687bd70-37b3-4f00-a900-0ba1cfaa5196",
    "id" : "fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
    "size" : 1,
    "os-extended-snapshot-attributes:progress" : "100%",
    "name" : "test03",
    "os-extended-snapshot-attributes:project_id" : "20a68d6b7a124ae2b6b8a22046ee5966",
    "service_type" : "EVS",
    "created_at" : "2018-05-30T03:14:44.457975",
    "metadata" : { }
  } ]
}

Status code: 400

Bad Request

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

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.evs.v2.region.EvsRegion;
import com.huaweicloud.sdk.evs.v2.*;
import com.huaweicloud.sdk.evs.v2.model.*;


public class ListSnapshotsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EvsClient client = EvsClient.newBuilder()
                .withCredential(auth)
                .withRegion(EvsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSnapshotsRequest request = new ListSnapshotsRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withName("<name>");
        request.withStatus("<status>");
        request.withVolumeId("<volume_id>");
        request.withAvailabilityZone("<availability_zone>");
        request.withId("<id>");
        request.withDedicatedStorageName("<dedicated_storage_name>");
        request.withDedicatedStorageId("<dedicated_storage_id>");
        request.withServiceType("<service_type>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        try {
            ListSnapshotsResponse response = client.listSnapshots(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkevs.v2.region.evs_region import EvsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkevs.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = EvsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EvsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSnapshotsRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.name = "<name>"
        request.status = "<status>"
        request.volume_id = "<volume_id>"
        request.availability_zone = "<availability_zone>"
        request.id = "<id>"
        request.dedicated_storage_name = "<dedicated_storage_name>"
        request.dedicated_storage_id = "<dedicated_storage_id>"
        request.service_type = "<service_type>"
        request.enterprise_project_id = "<enterprise_project_id>"
        response = client.list_snapshots(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := evs.NewEvsClient(
        evs.EvsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSnapshotsRequest{}
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	volumeIdRequest:= "<volume_id>"
	request.VolumeId = &volumeIdRequest
	availabilityZoneRequest:= "<availability_zone>"
	request.AvailabilityZone = &availabilityZoneRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	dedicatedStorageNameRequest:= "<dedicated_storage_name>"
	request.DedicatedStorageName = &dedicatedStorageNameRequest
	dedicatedStorageIdRequest:= "<dedicated_storage_id>"
	request.DedicatedStorageId = &dedicatedStorageIdRequest
	serviceTypeRequest:= "<service_type>"
	request.ServiceType = &serviceTypeRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ListSnapshots(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.