Getting information about a specific 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 gets basic information about the specified journal. To get journal time information or detailed journal information, run the API function for getting a list of journals.
Note: If the specified journal is used in a 3DC configuration and multiple MUs are set for the journal, information about only one MU can be acquired for the API. In this situation, run the API function for getting a list of journals to get the information about the target journal ID.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the journalId value obtained by getting information about the journal.

Attribute

Type

Description

journalId

int

(Required) Journal ID

Query parameters
None.
Body
None.

Response message

Body
{
  "journalId": 0,
  "muNumber": 1,
  "consistencyGroupId": 5,
  "journalStatus": "PJSF",
  "numOfActivePaths": 1,
  "usageRate": 0,
  "qMarker": "575cc653",
  "qCount": 0,
  "byteFormatCapacity": "1.88 G",
  "blockCapacity": 3956736,
  "numOfLdevs": 1,
  "firstLdevId": 513
}

Attribute

Type

Description

journalId

int

Journal ID

muNumber

int

MU (mirror unit) number

consistencyGroupId

int

Consistency group identifier

journalStatus

string

Journal volume status

For details, see the section explaining the mirror journal statuses.

numOfActivePaths

int

Number of active link paths

usageRate

int

Usage rate of the journal volume

qMarker

string

If the obtained journal is the master journal, the last sequential number (Q-marker) when the journal volume received the write data is output. If the obtained journal is the restore journal, the last sequential number (Q-marker) that is written in the cache is output.

qCount

long

Number of qMarker remaining in the master journal volume

byteFormatCapacity

string

Capacity of the journal volume

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the journal volume

numOfLdevs

int

Number of LDEVs configuring the journal volume

firstLdevId

int

LDEV number of the first LDEV assigned to the journal

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

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/0