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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition The query offset. This parameter is used together with the limit parameter to query snapshots by page. Assume that there are 30 snapshots. If you set offset to 11 and limit to 10, the query starts from the twelfth snapshot. A maximum of 10 snapshots can be queried at a time. Constraints N/A Range N/A Default Value N/A |
limit |
No |
Integer |
Definition The maximum number of query results that can be returned. Constraints N/A Range The value must be an integer greater than 0. Default Value 1000 |
name |
No |
String |
Definition The snapshot name. You can obtain it on the snapshot list page of the EVS console. Constraints N/A Range It can contain a maximum of 64 characters. Default Value N/A |
status |
No |
String |
Definition The snapshot status. For details, see EVS Snapshot Status. Constraints N/A Range N/A Default Value N/A |
volume_id |
No |
String |
Definition The ID of the snapshot's source disk. You can obtain it on the disk list page of the EVS console. Constraints N/A Range N/A Default Value N/A |
availability_zone |
No |
String |
Definition The AZ of the snapshot's source disk. Constraints N/A Range N/A Default Value N/A |
id |
No |
String |
Definition The snapshot ID used for filtering. You can obtain it on the snapshot list page of the EVS console. Constraints Multiple IDs can be transferred for filtering. The format is id=id1&id=id2&id=id3. Range N/A Default Value N/A |
dedicated_storage_name |
No |
String |
Definition The dedicated storage name. Constraints N/A Range N/A Default Value N/A |
dedicated_storage_id |
No |
String |
Definition The dedicated storage ID. Constraints N/A Range N/A Default Value N/A |
service_type |
No |
String |
Definition The service type. Constraints N/A Range The value can be EVS, DSS, or DESS. Default Value N/A |
enterprise_project_id |
No |
String |
Definition The enterprise project ID, which is used for filtering. If all_granted_eps is transferred, disks in all enterprise projects that are within the permission scope will be queried. For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition The user token. You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Definition The total number of snapshots. This value is not restricted by the limit parameter. Range N/A |
snapshots |
Array of SnapshotList objects |
Definition The snapshot information. Range N/A |
snapshots_links |
Array of Link objects |
Definition The query position marker in the snapshot list. This field is only returned when limit is specified in the request, and this field indicates that only some snapshots are returned in this query. Range N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition The snapshot ID. Range N/A |
status |
String |
Definition The snapshot status. Range N/A |
name |
String |
Definition The snapshot name. Range |
description |
String |
Definition The snapshot description. Range N/A |
created_at |
String |
Definition The time when the snapshot was created. Range N/A |
updated_at |
String |
Definition The time when the snapshot was updated. Range N/A |
metadata |
Map<String,String> |
Definition The snapshot metadata. Range N/A |
volume_id |
String |
Definition The snapshot's source disk. Range N/A |
size |
Integer |
Definition The snapshot size. Range N/A |
os-extended-snapshot-attributes:project_id |
String |
Definition The project ID. Range N/A |
os-extended-snapshot-attributes:progress |
String |
Definition The snapshot creation progress. Range N/A |
dedicated_storage_id |
String |
Definition The dedicated storage ID. Range N/A |
dedicated_storage_name |
String |
Definition The dedicated storage name. Range N/A |
service_type |
String |
Definition The service type. Range N/A |
Parameter |
Type |
Description |
---|---|---|
href |
String |
Definition The corresponding shortcut link. Range N/A |
rel |
String |
Definition The shortcut link marker name. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
Error object |
Definition The error code returned if an error occurs. For the error codes and their meanings, see Error Codes. Range N/A |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition The error code returned if an error occurs. Range For the error codes and their meanings, see Error Codes. |
message |
String |
Definition The error message returned if an error occurs. Range N/A |
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.
Java
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 |
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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); ListSnapshotsRequest request = new ListSnapshotsRequest(); 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()); } } } |
Python
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 |
# coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSnapshotsRequest() 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) |
Go
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSnapshotsRequest{} response, err := client.ListSnapshots(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot