文档首页/ 云硬盘 EVS/ API参考/ API/ 存量快照管理/ 查询单个云硬盘快照详情
更新时间:2025-08-20 GMT+08:00

查询单个云硬盘快照详情

功能介绍

查询单个云硬盘快照信息。支持企业项目授权功能。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/cloudsnapshots/{snapshot_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。

获取方法请参见"获取项目ID"。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

snapshot_id

String

参数解释

快照ID。

可通过EVS控制台的云硬盘快照列表页面获取云硬盘快照ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

snapshot

SnapshotDetails object

参数解释

快照信息。

取值范围

不涉及。

表4 SnapshotDetails

参数

参数类型

描述

id

String

参数解释

云硬盘快照ID。

取值范围

不涉及。

status

String

参数解释

云硬盘快照状态。

取值范围

关于云硬盘快照状态参见云硬盘快照状态

name

String

参数解释

云硬盘快照名称。

取值范围

不涉及。

description

String

参数解释

云硬盘快照描述信息。

取值范围

不涉及。

created_at

String

参数解释

云硬盘快照创建时间。

取值范围

时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

updated_at

String

参数解释

快照更新时间。

取值范围

时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

metadata

Object

参数解释

云硬盘快照的元数据信息。

取值范围

不涉及。

volume_id

String

参数解释

快照所属的云硬盘ID。

取值范围

不涉及。

size

Integer

参数解释

云硬盘快照大小,单位为GiB。

取值范围

不涉及。

os-extended-snapshot-attributes:project_id

String

参数解释

预留属性。

取值范围

不涉及。

os-extended-snapshot-attributes:progress

String

参数解释

预留属性。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时,返回的错误码。错误码和其对应的含义请参考错误码说明

取值范围

不涉及。

表6 Error

参数

参数类型

描述

code

String

参数解释

出现错误时,返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明

message

String

参数解释

出现错误时,返回的错误消息。

取值范围

不涉及。

请求示例

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

响应示例

状态码: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"
  }
}

状态码:400

Bad Request

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

SDK代码示例

SDK代码示例如下。

 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
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 ShowSnapshotSolution {

    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();
        ShowSnapshotRequest request = new ShowSnapshotRequest();
        request.withSnapshotId("{snapshot_id}");
        try {
            ShowSnapshotResponse response = client.showSnapshot(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
# 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 = ShowSnapshotRequest()
        request.snapshot_id = "{snapshot_id}"
        response = client.show_snapshot(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
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.ShowSnapshotRequest{}
	request.SnapshotId = "{snapshot_id}"
	response, err := client.ShowSnapshot(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码