Getting journal information

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 a list of information about a journal.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/journals

Request message

Object ID

None.

Query parameters

Parameter

Type

Filter Condition

journalInfo

string

(Required) Type of information to be obtained

The specifiable values are as follows:

  • basic: Basic journal information
  • timer: Journal time information
  • detail: Detailed journal information
Body
None.

Response message

Body

The following is an example of the output when basic journal information is obtained:

{
  "data": [
    {
      "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

The following is an example of the output when journal time information is obtained:

{
  "data": [
    {
      "journalId": 0,
      "muNumber": 1,
      "consistencyGroupId": 5,
      "journalStatus": "PJSF",
      "numOfActivePaths": 1,
      "usageRate": 0,
      "qMarker": "575cc653",
      "qCount": 0,
      "byteFormatCapacity": "1.88 G",
      "blockCapacity": 3956736,
      "dataOverflowWatchInSeconds": 60,
      "pathBlockadeWatchInMinutes": 5,
      "activePathWatchTimerSettingInSeconds": 40
    }
  ]
}

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

dataOverflowWatchInSeconds

int

Data Overflow Watch timer setting (in seconds) per the Journal

pathBlockadeWatchInMinutes

int

Path Blockade Watch timer setting (in minutes) per the Journal

activePathWatchTimerSettingInSeconds

int

Active Path Watch timer setting (in seconds) to detect any link failures

The following is an example of the output when detailed journal information is obtained:

{
  "data": [
    {
      "journalId": 0,
      "isMainframe": false,
      "isCacheModeEnabled": true,
      "isInflowControlEnabled": true,
      "dataOverflowWatchInSeconds": 60,
      "copySpeed": 256,
      "isDataCopying": true,
      "mpBladeId": 0,
      "mirrorUnits": [
        {
          "muNumber": 0,
          "consistencyGroupId": 0,
          "journalStatus": "SMPL",
          "pathBlockadeWatchInMinutes": 5,
          "copyPace": "L"
          "copySpeed": 256,
          "isDataCopying": true,
        },
          ...
          ...
        {
          "muNumber": 3,
          "consistencyGroupId": 0,
          "journalStatus": "SMPL",
          "pathBlockadeWatchInMinutes": 5,
          "copyPace": "L"
          "copySpeed": 256,
          "isDataCopying": true,
        }
      ]
    }
  ]
}

Attribute

Type

Description

journalId

int

Journal ID

isMainframe

boolean

Indicates whether the journal is used for mainframe systems or open systems
  • true: The journal is used for mainframe systems
  • false: The journal is used for open systems

mfTimerType

string

Timer type for mainframe systems

  • LOCAL: A local timer is used.
  • SYSTEM: A system timer is used.
  • none: A system timer is used (when the copy direction is the reverse).

isCacheModeEnabled

boolean

Indicates whether the cache mode setting is enabled

  • true: The cache mode setting is enabled.
  • false: The cache mode setting is disabled.

isInflowControlEnabled

boolean

Indicates whether an inflow of update I/O to the journal volume is limited

  • true: Inflow is limited.
  • false: Inflow is unlimited.

dataOverflowWatchInSeconds

int

Data Overflow Watch timer setting (in seconds) per the Journal

copySpeed

int

Transfer speed (in Mbps)

The value set for the object whose MU (mirror unit) number is 3 is output. For details about the value for each mirror, see the description of the copySpeed attribute of the mirrorUnits object.

isDataCopying

boolean

Copy mode "true" or "false" under failure of the delta resync:

  • true: copying ALL data
  • false: No copying

The value set for the object whose MU (mirror unit) number is 3 is output. For details about the value for each mirror, see the description of the isDataCopying attribute of the mirrorUnits object.

mpBladeId

int

MP blade ID

mirrorUnits

object[]

The following attributes are output for each mirror:

  • muNumber (int)

    MU (mirror unit) number

  • consistencyGroupId (int)

    Consistency group ID

  • journalStatus (string)

    The journal status

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

  • pathBlockadeWatchInMinutes (int)

    Path Blockade Watch timer setting (in minutes) per the Journal

  • copyPace (string)

    Copy speed

    • L: Low speed
    • M: Medium speed
    • H: High speed
  • copySpeed (int)

    Transfer speed (in Mbps)

  • isDataCopying (boolean)

    Copy mode "true" or "false" under failure of the delta resync:

    • true: copying ALL data
    • false: No copying

Status codes

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

Coding example

To get basic journal information:

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?journalInfo=basic

To get journal time information:

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?journalInfo=timer

To get detailed journal information:

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?journalInfo=detail