Deleting garbage data of all Thin Image pairs in a snapshot tree

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17

You can delete garbage data (defragment the snapshot data area) by specifying the root volume of a snapshot tree. You can stop the processing before the deletion processing is complete. Before running this API request, we recommend that you get volume information to check the usage status of snapshots and the volume of garbage data.

Note:

You can use this API request for VSP 5000 series storage systems.

Execution permission

Storage Administrator (Local Copy)

Request line

POST base-URL/v1/services/snapshot-tree/actions/delete-garbage-data/invoke

Request message

Object ID

None.

Query parameters

None.

Body
{
  "parameters": {
    "ldevId": 66,
    "operationType": "start"
  }
}

Attribute

Type

Description

ldevId

int

(Required) LDEV number of the root volume

operationType

string

(Required) Starts or stops the deletion of garbage data.

The following values can be specified:

  • start: Starts the processing for deleting garbage data
  • stop: Stops the processing for deleting garbage data

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section that explains job objects.

Attribute

Description

affectedResources

URL of the root volume

To check whether garbage data has been deleted from a snapshot tree, do not check the job status. Instead, get the attributes of the volume to check the status of the processing for deleting the garbage data.

The processing to delete garbage data stops automatically when the remaining amount of garbage data is less than 1 GB.

In some cases, the processing to delete garbage data stops even if the remaining amount of garbage data is 1 GB or more. In such cases, rerun the processing to delete garbage data, so that the remaining amount of garbage data becomes less than 1 GB.

Action template

None.

Status codes

For details about the status codes issued in response to requests for this operation, see the description of HTTP status codes.

Code example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/services/snapshot-tree/actions/delete-garbage-data/invoke