Help Center/ Elastic Volume Service/ API Reference/ API/ Snapshot Management/ Rolling Back a Snapshot to an EVS Disk
Updated on 2024-02-27 GMT+08:00

Rolling Back a Snapshot to an EVS Disk

Function

This API is used to roll back a snapshot to an EVS disk. Enterprise project authorization is supported.

Constraints

  • A snapshot can be rolled back only to its source disk. Rollback to another disk is not possible.

  • You can roll back a disk from a snapshot only when the disk is in the available or error_rollbacking state.

  • Snapshots whose names started with the autobk_snapshot_ prefix are automatically created by the system when backups are created. Such snapshots cannot be used to roll back data.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/cloudsnapshots/{snapshot_id}/rollback

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.

snapshot_id

Yes

String

The snapshot ID.

Request Parameters

Table 2 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

rollback

Yes

RollbackSnapshotOption object

The snapshot rollback information.

Table 4 RollbackSnapshotOption

Parameter

Mandatory

Type

Description

name

No

String

The name of the disk to be rolled back.

volume_id

Yes

String

The UUID of the disk to be rolled back.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

rollback

RollbackInfo object

The snapshot rollback information.

Table 6 RollbackInfo

Parameter

Type

Description

volume_id

String

The UUID of the disk to be rolled back.

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

Rolling back a snapshot to an EVS disk (The target disk name is test-001 and UUID is 5aa119a8-d25b-45a7-8d1b-88e127885635.)

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

{
  "rollback" : {
    "name" : "test-001",
    "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635"
  }
}

Example Responses

Status code: 202

Accepted

{
  "rollback" : {
    "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635"
  }
}

Status code: 400

Bad Request

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

SDK Sample Code

The SDK sample code is as follows.

Rolling back a snapshot to an EVS disk (The target disk name is test-001 and UUID is 5aa119a8-d25b-45a7-8d1b-88e127885635.)

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

    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();
        RollbackSnapshotRequest request = new RollbackSnapshotRequest();
        RollbackSnapshotRequestBody body = new RollbackSnapshotRequestBody();
        RollbackSnapshotOption rollbackbody = new RollbackSnapshotOption();
        rollbackbody.withName("test-001")
            .withVolumeId("5aa119a8-d25b-45a7-8d1b-88e127885635");
        body.withRollback(rollbackbody);
        request.withBody(body);
        try {
            RollbackSnapshotResponse response = client.rollbackSnapshot(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());
        }
    }
}

Rolling back a snapshot to an EVS disk (The target disk name is test-001 and UUID is 5aa119a8-d25b-45a7-8d1b-88e127885635.)

 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
# 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 = RollbackSnapshotRequest()
        rollbackbody = RollbackSnapshotOption(
            name="test-001",
            volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635"
        )
        request.body = RollbackSnapshotRequestBody(
            rollback=rollbackbody
        )
        response = client.rollback_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)

Rolling back a snapshot to an EVS disk (The target disk name is test-001 and UUID is 5aa119a8-d25b-45a7-8d1b-88e127885635.)

 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
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.RollbackSnapshotRequest{}
	nameRollback:= "test-001"
	rollbackbody := &model.RollbackSnapshotOption{
		Name: &nameRollback,
		VolumeId: "5aa119a8-d25b-45a7-8d1b-88e127885635",
	}
	request.Body = &model.RollbackSnapshotRequestBody{
		Rollback: rollbackbody,
	}
	response, err := client.RollbackSnapshot(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

202

Accepted

400

Bad Request

Error Codes

See Error Codes.