Deleting a journal volume from a journal

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
The following request deletes the specified journal volume from a journal to shrink the journal.

Execution permission

Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/journals/object-ID/actions/shrink/invoke

Request message

Object ID
Specify the value of journalId that was obtained by the processing to get information about journals.

Attribute

Type

Description

journalId

int

(Required) Journal ID

Query parameters
None.
Body
{
  "parameters": {
    "ldevIds": [101]
  }
}

Attribute

Type

Description

ldevIds

int[]

(Required) Specify the LDEV number with a decimal (base 10) number.

You can specify only one LDEV.

Response message

Body

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

Attribute

Description

affectedResources

URL of the journal from which a volume was deleted

Action template

GET base-URL/v1/objects/journals/object-ID/actions/shrink

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

Only one journal volume exists in the target journal, or pairs are created and the status of the journal volume is normal.

Coding example

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/journals/3/actions/shrink

To run the request after getting an action template:

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/objects/journals/3/actions/shrink/invoke