Creating Snapshot

POST /volume/{volume_id}/snapshot

Introduction

Creates a Snapshot of the specified Volume.

Creates a destination Volume (Snapshot Volume) automatically and creates a SnapOPC or SnapOPC+ Session from a specified Volume.

Caution

  • Source Volume Types are Standard, TPV, FTV, and WSV (Except for the system volume).

  • The destination Volume Type is TPV only.

  • You cannot make an already-created Volume a Snapshot (cannot create a SnapOPC session or a SnapOPC+ session whose copy destination is set with an already-created Volume).

  • You can find the Href of the created Snapshot in resource_href_list of "GET /job/{job_id}".

  • You can check the status of the created Snapshot with "GET /volume/{volume_id}/copysession".

  • The maximum number of SnapOPC+ Sessions that can be created per Volume is 512.

  • For tenant users, only Thin Provisioning Pools that belong to the tenant of the current user can be specified.

  • If the creation destination Thin Provisioning Pool belongs to a tenant, the Snapshot to be created will also belong to that same tenant.

Request Examples

  • This is an example of creating a Snapshot of Volume ID 100001 in Thin Provisioning Pool ID 0.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume/100001/snapshot" -d
'{
"name": "snapshot#0",
"tpp_id": 0
}'

Response Examples

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID.

REQUEST BODY

name

(required)

string

The destination Volume name to create.

Input criteria:

The available number of characters allowed is 1 to 32.

  • Acceptable characters are single byte alphanumeric characters. However, "," and "?" are excluded.

  • You cannot use a Volume name that already exists.

  • The following Volume names are not allowed:

    • Volume name starting with "$VVOL_META".

    • Volume name starting with "$DATA_CNTNR".

    • Volume name starting with "$SYSVOL".
tpp_id

(required)

The allowed values are 0 to 65535.

ID of the destination Thin Provisioning Pool.

Input criteria:

  • You cannot specify a Thin Provisioning Pool that does not exist.

  • For tenant users, Thin Provisioning Pools cannot be specified if they do not belong to the tenant of the current user.
is_manual_snapshot

boolean

Default: false

Whether to manage generations for the snapshots you create.

If true, generations for snapshots to be created are not managed (Create a SnapOPC Session).

If false, generations for snapshots to be created are managed (Create a SnapOPC+ Session).
is_data_reduction_disabled

boolean

Data Reduction disable settings.

If true, Deduplication and/or Compression is disabled for the data written to the Volume being created.

If false, Deduplication and/or Compression is enabled for the data written to the Volume being created.

Input criteria:

  • This item can only be specified if Data Reduction is enabled for the destination Thin Provisioning Pool.

Caution

If Data Reduction is enabled for Snapshot, the deduplication and data compression operations are synchronized with the copy operation and may degrade I/O and copy performance. If the Snapshot destination Thin Provisioning Pool has Data Reduction enabled, but you want to avoid performance degradation to the source Volume, disable Data Reduction for Snapshot with this Parameter.

Responses

If the job registration is successful, the HTTP status code will be 202 (Accepted) and the response body will respond.

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.