Creating 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 creates a journal and then adds a journal volume. Specify a DP volume for a journal volume to be added.

Execution permission

Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/journals

Request message

Object ID

None.

Query parameters
None.
Body
The following is a coding example for creating a journal by specifying the LDEV number:
{
  "journalId": 33,
  "ldevIds": [101,102]
}

When creating a journal by specifying the LDEV number

Attribute

Type

Description

journalId

int

(Required) Specify the journal ID.

Specify a decimal (base 10) number in the range from 0 to 255.

ldevIds

int[]

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

You can specify up to 2 numbers.

The following is a coding example for creating a journal by specifying a range of consecutive LDEV numbers:

{
  "journalId": 33,
  "startLdevId": 101,
  "endLdevId": 102
}

When creating a journal by specifying a range of consecutive LDEV numbers

Attribute

Type

Description

journalId

int

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

startLdevId

int

(Required) Specify the first LDEV number by using a decimal (base 10) number.

The value of this attribute must be smaller than that of endLdevId.

endLdevId

int

(Required) Specify the last LDEV number by using a decimal (base 10) number.

The value of this attribute must be greater than that of startLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 2 LDEVs.

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 created journal

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

409

Conflict

A journal that has the specified journal ID already exists.

Coding 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/objects/journals