• Native OpenStack API

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

Create Snapshot

Function Description

This interface is used to create a volume snapshot.

Interface Format

Method

URI

Description

POST

/v2/{tenant_id}/snapshots

This interface is used to create a volume snapshot.

Restrictions

The name of the created volume snapshot cannot start with autobk_snapshot_.

Request Parameter

The following table lists request filter parameters.

Parameter

Type

Mandatory

Remarks

snapshot

Dict

Yes

Specifies the snapshot.

volume_id

String

Yes

Specifies the UUID.

force

bool

No

Indicates that the snapshot is forcibly created, including the case that the volume is attached. The default value of this parameter is false.

metadata

Dict

No

Specifies the metadata of the volume snapshot.

description

String

No

Describes the volume snapshot. The value of this parameter can be null.

name

String

No

Specifies the name of the volume snapshot.

Response Parameter

Parameter

Type

Mandatory

Remarks

snapshot

Dict

Yes

Specifies the snapshot.

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

Describes the volume snapshot.

created_at

String

Yes

Specifies the time when the volume snapshot was created.

metadata

Dict

No

Specifies the metadata of the volume snapshot.

volume_id

Uuid

Yes

Specifies the volume for the snapshot.

size

Int

Yes

Specifies the size of the volume snapshot.

updated_at

String

No

Specifies the time when the snapshot was updated.

Request Parameter

POST /v2/d6c277ba8820452e83df36f33c9fa561/snapshots
{
    "snapshot": {
        "name": "snap-001",
        "description": "Daily backup",
        "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
        "force": false
"metadata":{}
    }
}

Response Parameter

{
    "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"
    }
}
normal status code:202

Error Code

See section Processing Return Code.