• Native OpenStack API

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

Update Snapshot

Function Description

This interface is used to update the attributes of a snapshot.

Interface Format

Method

URI

Description

PUT

/v3/{project_id}/snapshots/{snapshot_id}

This interface is used to update the attributes of a snapshot.

Restrictions

N/A

Expanded Interface

N/A

Request Parameter

Parameter

Type

Mandatory

Remarks

name

String

No

Specifies a volume name, which consists of fewer than 255 characters.

description

String

No

Specifies a volume description, which consists of fewer than 255 characters.

display_name

String

No

Also specifies the disk name, which consists of fewer than 255 characters. You can specify either parameter name or display_name.

display_description

String

No

Also specifies the disk description, which consists of fewer than 255 characters. You can specify either parameter description or display_description.

Response Parameter

Parameter

Type

Mandatory

Remarks

snapshot

Dict

Yes

Snapshot information

id

Uuid

Yes

Specifies the volume snapshot ID.

status

String

Yes

Specifies the status of the volume snapshot.

name

String

No

Specifies the name of the volume snapshot.

description

String

No

Provides supplementary information about the volume snapshot.

created_at

String

Yes

Specifies the volume snapshot creation time.

metadata

Dict

No

Specifies metadata of the volume snapshot.

volume_id

Uuid

Yes

Specifies the volume to which the snapshot belongs.

size

Int

Yes

Specifies the volume snapshot size.

updated_at

String

No

Specifies the time when the snapshot was updated.

Request Example

PUT https://volume.localdomain.com:8776/v3/cc0f77b560f8432fb5eb86f0cbb91799/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
{
"snapshot": {
           "name": "name_xx3", 
           "description": "hello"
           }
}

Response Example

 {
    "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": "f9faf7df-fdc1-4093-9ef3-5cba06eef995",
        "name": "snap-001"
"updated_at":" 2013-02-25T03:56:53.081642"
    }
}

Error Code

See section Processing Return Code.