Updated on 2025-08-20 GMT+08:00

Rolling Back Disk Data from a Snapshot

Function

This API is used to roll back disk data from a snapshot. Standard snapshots are available only in some regions. To check the supported regions, see the region information shown under "EVS Snapshots" in Function Overview

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/snapshots/{snapshot_id}/rollback

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

For details, see Obtaining a Project ID.

Default Value

N/A

snapshot_id

Yes

String

The snapshot ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

rollback

Yes

RollbackSnapshotRequestBody object

The snapshot rollback information.

Table 4 RollbackSnapshotRequestBody

Parameter

Mandatory

Type

Description

name

No

String

The name of the disk you want to roll back data.

volume_id

Yes

String

The UUID of the disk you want to roll back data.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

The task ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A

Table 7 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about 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

POST /v5/{project_id}/snapshots/{snapshot_id}/rollback

Example Responses

Status code: 202

Accepted

{
  "job_id" : "ee62a0c1e79c4e11be5adc17a49f69ef"
}

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

Error Codes

See Error Codes.