• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Snapshot
  6. Rollback snapshot

Rollback snapshot

Function Description

This interface is used to roll back a snapshot to a volume.

Interface Format

Method

URI

Description

POST

/v3/{project_id}/os-vendor-snapshots/{snapshot_id}/rollback

This interface is used to roll back a snapshot to a volume.

Restrictions

  • When you roll back a snapshot to a volume, you can only roll back the snapshot to the source volume. Rollback to a specified volume is not supported.
  • You can roll back a snapshot to a volume only when the volume is in the available or error_rollbacking state.

Extension Description

N/A

Request Parameter

Parameter

Type

Mandatory

Remarks

rollback

map

Yes

Specifies the snapshot rollback information.

volume_id

string

No

Specifies the UUID of the volume to be rolled back.

name

string

No

Specifies the name of the volume to be rolled back. The value contains a maximum of 255 bytes.

Response Parameter

Parameter

Type

Mandatory

Remarks

rollback

map

Yes

Specifies the snapshot rollback information.

volume_id

string

Yes

Specifies the UUID of the target volume in a snapshot rollback.

Request Example

PUT https://volume.localdomain.com:8776/v3/5f13ecc9281d4c34bd740f277620bdee/os-vendor-snapshots/d23a846b-0c0c-427a-a490-84331c33c52f/rollback
{
    "rollback": {
        "name": "test-001",
        "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
    }
}

Response Example

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

Error Code

See section Processing Return Code.