Responses returned by YKQUERY

Business Continuity Manager Web API Reference Guide

Version
9.8.8
File Size
1.6 MB
Audience
anonymous
Part Number
MK-96HC137-00

This response outputs only summary information for the entire copy group. To obtain the copy pair status of each copy pair or copy group, run YKGETGRP. However, if you specify the DEVN parameter for the operands key, information about pairs specified as the value of the DEVN parameter will be output, but summary information (such as the number of pairs in each pair status) will not be output.

The following describes the unique response items returned by YKQUERY. For details about response items common to each command, see Responses common to all CLI commands.

Response body (when the DEVN parameter is not specified)

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"098800",
    "vendor":"hitachi",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKQUERY",
    "operands":"",
    "prefix":"USERID.PREFIX",
    "copyGroup":{
      "ID":"CGID",
      "updateID":"FFFFFFFFFFFFFFFF",
      "description":"CG Description",
      "copyType":"TC",
      "primaryDADID":"DADP",
      "secondaryDADID":"DADR",
      "primarySCHSET":"0",
      "secondarySCHSET":"0",
      "pairCt":5,
      "simplexCt":0,
      "pendingCt":2,
      "duplexCt":3,
      "transitionCt":0,
      "suspendOpCt":0,
      "suspendCuCt":0,
      "suspendVSCt":0,
      "swappingCt":0,
      "reversedCt":0,
      "suspendErCt":0,
      "invalidCt":0,
      "revrsyncCt":0,
      "holdCt":0,
      "holdErCt":0,
      "chkJnlCt":0,
      "holdTrnsCt":0,
      "noDeltaCt":0,
      "conslostCt":0,
      "priOnlineCt":0,
      "secOnlineCt":0,
      "CTDelta":"000 00:00:00",
      "matchingPerCent":80
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

prefix

string or undefined

Prefix of the copy group definition file

copyGroup

object or undefined

Copy group object

ID

string

Copy group ID

updateID

string

Last update ID

description

string or undefined

Descriptions added by the user

copyType

string

Copy type

One of SI, TC, or UR is output.

primaryDADID

string

DADID of the P-VOL of the copy group

secondaryDADID

string

DADID of the S-VOL of the copy group

primarySchSet

string

Subchannel set ID of the P-VOL of the copy group

secondarySchSet

string

Subchannel set ID of the S-VOL of the copy group

pairCt

number

Total number of copy pairs for all consistency groups in the copy group

simplexCt

number

Number of copy pairs in SIMPLEX status in the copy group

pendingCt

number

Number of copy pairs in PENDING status in the copy group

duplexCt

number

Number of copy pairs in DUPLEX status in the copy group

transitionCt

number

Number of copy pairs in TRANS status in the copy group

suspendOpCt

number

Number of copy pairs in SUSPOP status in the copy group

suspendCuCt

number

Number of copy pairs in SUSPCU status in the copy group

suspendVsCt

number

Number of copy pairs in SUSPVS status in the copy group

swappingCt

number

Number of copy pairs in SWAPPING status in the copy group

reversedCt

number

Number of copy pairs in the copy group whose copy direction is from secondary to primary

suspendErCt

number

Number of copy pairs in SUSPER status in the copy group

invalidCt

number

Number of copy pairs in INVALID status in the copy group

revrsyncCt

number

Number of copy pairs in REVRSY status in the copy group

holdCt

number

Number of copy pairs in HOLD status in the copy group

holdErCt#1

number

Number of copy pairs in HOLDER status in the copy group

chkJnlCt#2

number

Number of copy pairs in CHKJNL status in the copy group

holdTrnsCt#1

number

Number of copy pairs in HOLDTRNS status in the copy group

noDeltaCt#1

number

Number of copy pairs in NODELTA status in the copy group

conslostCt

number

Number of copy pairs in CONSLOST status in the copy group

priOnlineCt#1

number

Number of online volumes at the primary site in the copy group

secOnlineCt#1

number

Number of online volumes at the secondary site in the copy group

CTDelta#3 #6

string or undefined

Proxy C/T delta value for the entire copy group

matchingPerCent#1 #4 #5 #7

number or undefined

Rate of copy pair matches in the copy group

Note: The items in the preceding table are output when the rc key value is 8 or less.

#1

If you specify the TO parameter as the value of the operands key, sometimes information cannot be obtained and the value becomes 0.

#2

The value is always 0.

#3

The following table lists and describes the C/T delta values.

Condition

Output value

Copy group container that is not EXCTG

Maximum C/T delta value for the entire consistency group

EXCTG

Minimum C/T delta value for the entire consistency group

#4

If copy pairs other than ShadowImage are in the suspend status, the displayed values correspond to the amounts written to the P-VOL after the suspension, and do not include the amounts written to the S-VOL. When these copy pairs are resynchronized, the values might change, because the values corresponding to the amounts written to the P-VOL and S-VOL are adjusted when the differential copy is performed.

#5

Average matching rate of copy pairs in a copy group.

#6

In the following cases, this is not output.

  • If you specified the TO(PRIMARY) parameter as the value of the operands key
  • If the copy type is not Universal Replicator
  • If the timer type is not SYSTEM
  • If the copy group includes a consistency group for which one or more C/T delta values cannot be obtained
#7

If you specified the TO(SECONDARY) parameter as the value of the operands key, this is not output.

Response body (when the DEVN parameter is specified)

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"098800",
    "vendor":"hitachi",  
    "rc":0,
    "bcmMsg":[
    ],
   "action":"submit",
   "cliname":"YKQUERY",
   "operands":"DEVN(A000,A000)",
   "prefix":"USERID.PREFIX",
   "copyGroup":{
     "ID":"CGID",
     "updateID":"FFFFFFFFFFFFFFFF",
     "description":"CG Description",
     "copyType":"UR",
     "primaryDADID":"DADP",
     "secondaryDADID":"DADR",
     "primarySCHSET":"0",
     "secondarySCHSET":"0",
     "pairCt":5,
     "CTGroup":[
       {
         "groupIndex":1,
         "CTGroupID":"11",
         "subCTGroupID":"21",
         "pair":[
           {
              "pairIndex":1,
              "state":"SIMPLEX",
              "CTDelta":"000 00:00:00",
              "volser":"",
              "matchingPerCent":0,
              "reversed":"0",
              "CTTime": "20220101 00:00:00.000000",
              "diagnosis":"",
              "pri":{
                "devn":"A000",
                "serialNum":"11111",
                "CUNum":"11",
                "SSID":"1111",
                "CCA":"11",
                "model":"VSPG1000",
                "hostStatus":"OFFLINE",
             },
         "sec":{
               "devn":"A000",
               "serialNum":"22222",
               "CUNum":"22",
               "SSID":"2211",
               "CCA":"22",
               "model":"VSPG1000",
               "hostStatus":"OFFLINE",
              }
            }
          ]
        }
      ]
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

prefix

string or undefined

Prefix of the copy group definition file

copyGroup

object or undefined

Copy group object

ID

string

Copy group ID

updateID

string

Last update ID

description

string or undefined

Descriptions added by the user

copyType

string

Copy type

One of SI, TC, or UR is output.

primaryDADID

string

Device address domain ID of the P-VOL of the copy group

secondaryDADID

string

Device address domain ID of the S-VOL of the copy group

primarySchSet

string

Subchannel set ID of the P-VOL of the copy group

secondarySchSet

string

Subchannel set ID of the S-VOL of the copy group

pairCt

number

Total number of copy pairs for all consistency groups in the copy group

CTGroup

object array

Array of consistency group object

groupIndex

number

Sequence number of the consistency group

CTGroupID#1

string or undefined

Consistency group ID or master journal group ID

subCTGroupID#2

string or undefined

Restore journal group ID

pair

object array

Array of copy pair objects

pairIndex

number

Sequence number of copy pair

state

string

Copy pair status

CTDelta#3 #10

string or undefined

C/T delta value

volser#4

string or undefined

Volume serial number

matchingPerCent#5 #6 #7 #8

number or undefined

Rate of copy pair matches in the copy group

reversed

string

Whether direction is reverse from Secondary to Primary

  • 1
  • 0

CTTime#3 #10

string or undefined

Consistency time

diagnosis#9 #10

string or undefined

Diagnosis information

pri

object

P-VOL object

devn

string

Device number of the P-VOL

serialNum

string

Serial number of the primary storage system

CUNum

string

Control unit number of the P-VOL

SSID

string

Primary SSID

CCA

string

Command control address of the P-VOL

model

string

Primary storage system model

hostStatus#8

string or undefined

Host connection status of the P-VOL

  • ONLINE
  • OFFLINE

sec

object

S-VOL object

devn

string

Device number of the S-VOL

serialNum

string

Serial number of the secondary storage system

CUNum

string

Control unit number of the S-VOL

SSID

string

Secondary SSID

CCA

string

Command control address of the S-VOL

model

string

Secondary storage system model

hostStatus#10

string or undefined

Host connection status of the S-VOL

  • ONLINE
  • OFFLINE

Note1: The items in the preceding table are output when the rc key value is 8 or less.

#1

This is output for consistency groups and journal groups.

#2

This is output for journal groups.

#3

In the following cases, this is not output.

  • If the copy type is not Universal Replicator
  • If the timer type is not SYSTEM
  • If the copy group includes a consistency group for which one or more C/T delta values cannot be obtained
#4

This is not output if information could not be acquired during the volume scan.

#5

If copy pairs other than ShadowImage are in the suspend status, the displayed values correspond to the amounts written to the P-VOL after the suspension, and do not include the amounts written to the S-VOL. When these copy pairs are resynchronized, the values might change, because the values corresponding to the amounts written to the P-VOL and S-VOL are adjusted when the differential copy is performed.

#6

The value acquired from the primary site is usually set. However, if the copy type is ShadowImage, the value acquired from the primary or secondary site is set.

#7

If the copy type is Universal Replicator and the copy status is DUPLEX, the value is 100.

#8

If you specified the TO(SECONDARY) parameter as the value of the operands key, this is not output.

#9

If the copy type is not Universal Replicator, this is not output.

#10

If you specified the TO(PRIMARY) parameter as the value of the operands key, this is not output.