文档首页/ 云硬盘 EVS/ API参考/ API/ 快照管理/ 创建云硬盘快照
更新时间:2024-02-27 GMT+08:00

创建云硬盘快照

功能介绍

创建云硬盘快照。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/cloudsnapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

snapshot

CreateSnapshotOption object

快照信息。

表4 CreateSnapshotOption

参数

是否必选

参数类型

描述

volume_id

String

源云硬盘的ID。

force

Boolean

强制创快照标示,默认为false。 当force标记为false时,云硬盘处于挂载状态时,不能强制创建快照。 当force标记为true时,即使云硬盘处于挂载状态时,仍可以创建快照。

metadata

Map<String,String>

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

description

String

云硬盘快照描述,最大支持85个字符。

最小长度:0

最大长度:255

name

String

云硬盘快照名称。最大支持64个字符。

对云硬盘创建备份时,同时会创建以autobk_snapshot_为名称前缀的快照,云硬盘控制台对此类快照会有操作限制。 因此建议不要创建以autobk_snapshot_为名称前缀的快照,避免影响快照的正常使用。

最小长度:0

最大长度:255

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

snapshot

SnapshotDetails object

快照信息

表6 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

表7 响应Body参数

参数

参数类型

描述

error

Error object

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

表8 Error

参数

参数类型

描述

code

String

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

message

String

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

请求示例

创建一个云硬盘快照,当源云硬盘处于挂载状态时,不能强制创建快照。

POST https://{endpoint}/v2/{project_id}/cloudsnapshots

{
  "snapshot" : {
    "name" : "snap-001",
    "description" : "Daily backup",
    "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
    "force" : false,
    "metadata" : {
      "key_string" : "value_string"
    }
  }
}

响应示例

状态码: 202

Accepted

{
  "snapshot" : {
    "status" : "creating",
    "description" : "Daily backup",
    "created_at" : "2013-02-25T03:56:53.081642",
    "metadata" : { },
    "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
    "size" : 1,
    "id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
    "name" : "snap-001",
    "updated_at" : "2013-02-25T03:56:53.081642"
  }
}

状态码: 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
49
50
51
52
53
54
55
56
57
58
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.*;

import java.util.Map;
import java.util.HashMap;

public class CreateSnapshotSolution {

    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();
        CreateSnapshotRequest request = new CreateSnapshotRequest();
        CreateSnapshotRequestBody body = new CreateSnapshotRequestBody();
        Map<String, String> listSnapshotMetadata = new HashMap<>();
        listSnapshotMetadata.put("key_string", "value_string");
        CreateSnapshotOption snapshotbody = new CreateSnapshotOption();
        snapshotbody.withVolumeId("5aa119a8-d25b-45a7-8d1b-88e127885635")
            .withForce(false)
            .withMetadata(listSnapshotMetadata)
            .withDescription("Daily backup")
            .withName("snap-001");
        body.withSnapshot(snapshotbody);
        request.withBody(body);
        try {
            CreateSnapshotResponse response = client.createSnapshot(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
41
42
# 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 = CreateSnapshotRequest()
        listMetadataSnapshot = {
            "key_string": "value_string"
        }
        snapshotbody = CreateSnapshotOption(
            volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635",
            force=False,
            metadata=listMetadataSnapshot,
            description="Daily backup",
            name="snap-001"
        )
        request.body = CreateSnapshotRequestBody(
            snapshot=snapshotbody
        )
        response = client.create_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
39
40
41
42
43
44
45
46
47
48
49
50
51
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.CreateSnapshotRequest{}
	var listMetadataSnapshot = map[string]string{
        "key_string": "value_string",
    }
	forceSnapshot:= false
	descriptionSnapshot:= "Daily backup"
	nameSnapshot:= "snap-001"
	snapshotbody := &model.CreateSnapshotOption{
		VolumeId: "5aa119a8-d25b-45a7-8d1b-88e127885635",
		Force: &forceSnapshot,
		Metadata: listMetadataSnapshot,
		Description: &descriptionSnapshot,
		Name: &nameSnapshot,
	}
	request.Body = &model.CreateSnapshotRequestBody{
		Snapshot: snapshotbody,
	}
	response, err := client.CreateSnapshot(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码