# 创建云硬盘快照 - CreateSnapshot #### 功能介绍 创建云硬盘快照。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | evs:snapshots:create | Write | snapshot \* | - | - | - | | evs:snapshots:create | Write | volume \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | | evs:snapshots:create | Write | - | - evs:SourceAvailabilityZone - evs:AvailabilityZone | - | - | #### URI POST /v2/{project_id}/cloudsnapshots 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | snapshot | 是 | [CreateSnapshotOption] object | **参数解释** 快照信息。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表4CreateSnapshotOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | volume_id | 是 | String | **参数解释** 源云硬盘的ID。 可通过[查询所有云硬盘详情](https://support.huaweicloud.com/api-evs/evs_04_2006.html)获取云硬盘ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | force | 否 | Boolean | **参数解释** 强制创快照标示。 **约束限制** 当force标记为false时，云硬盘处于挂载状态时，不能强制创建快照。 当force标记为true时，即使云硬盘处于挂载状态时，仍可以创建快照。 **取值范围** false或true。 **默认取值** false | | metadata | 否 | Map\ | **参数解释** 云硬盘快照的metadata信息 ，调用方可以添加或删除metadata信息。当前部分key在EVS服务中有业务场景含义，这部分key的描述如下： - \[__system__cmkid\] metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 请求获取密钥ID的方法请参考："[查询密钥列表](https://support.huaweicloud.com/api-dew/ListKeys.html)"。 - \[__system__encrypted\] metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。 - \[hw:passthrough\] - true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 - false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 - 该字段不存在时，云硬盘默认为VBD类型。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | description | 否 | String | **参数解释** 云硬盘快照描述。 **约束限制** 不涉及。 **取值范围** 最大支持85个字符。 **默认取值** 不涉及。 | | name | 否 | String | **参数解释** 云硬盘快照名称。 对云硬盘创建备份时，同时会创建以autobk_snapshot_为名称前缀的快照，云硬盘控制台对此类快照会有操作限制。 因此建议不要创建以autobk_snapshot_为名称前缀的快照，避免影响快照的正常使用。 **约束限制** 不涉及。 **取值范围** 最大支持64个字符。 **默认取值** 不涉及。 | #### 响应参数 **状态码：202** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshot | [SnapshotDetails] object | **参数解释** 快照信息。 **取值范围** 不涉及。 | 表6SnapshotDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 云硬盘快照ID。 **取值范围** 不涉及。 | | status | String | **参数解释** 云硬盘快照状态。 **取值范围** 关于云硬盘快照状态参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | 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 | **参数解释** 云硬盘快照的metadata信息 ，调用方可以添加或删除metadata信息。当前部分key在EVS服务中有业务场景含义，这部分key的描述如下： - \[__system__cmkid\] metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 请求获取密钥ID的方法请参考："[查询密钥列表](https://support.huaweicloud.com/api-dew/ListKeys.html)"。 - \[__system__encrypted\] metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。 - \[hw:passthrough\] - true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 - false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 - 该字段不存在时，云硬盘默认为VBD类型。 **取值范围** 不涉及。 | | 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 | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 包含错误码和错误消息的对象 | 表8Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | 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代码示例如下。 - [Java] 创建一个云硬盘快照，当源云硬盘处于挂载状态时，不能强制创建快照。 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("")) .build(); CreateSnapshotRequest request = new CreateSnapshotRequest(); CreateSnapshotRequestBody body = new CreateSnapshotRequestBody(); Map 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()); } } } ``` - [Python] 创建一个云硬盘快照，当源云硬盘处于挂载状态时，不能强制创建快照。 ``` # 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("")) \ .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) ``` - [Go] 创建一个云硬盘快照，当源云硬盘处于挂载状态时，不能强制创建快照。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := evs.EvsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/EVS/sdk?api=CreateSnapshot)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 202 | Accepted | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。