Getting information about all of remote copy pairs

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 the remote copy pairs (TrueCopy, Universal Replicator, or global-active device) registered in the target storage system. You can obtain information about all such pairs from the cache of the storage system, regardless of whether they are managed by using copy groups. You do not need to specify the information about the remote storage system in the request message.
Note:
  • This API can be used when the storage system is the VSP 5000 series.

  • To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/storages/remote-replications

Request message

Object ID

None.

Query parameters

Parameter

Type

Filter condition

startLdevId

int

(Optional) To specify a range of LDEVs, specify the LDEV number of the first LDEV in the range.

The P-VOLs and S-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

Specify a value in the range from 0 to 65279.

The value of this parameter must be smaller than that of the endLdevId parameter.

If this attribute is omitted, 0 is set.

endLdevId

int

(Optional) To specify a range of LDEVs, specify the LDEV number of the last LDEV in the range.

The P-VOLs and S-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

Specify a value in the range from 0 to 65279.

The value of this parameter must be greater than that of the startLdevId parameter.

If this attribute is omitted, the maximum LDEV number in the storage system is set.

replicationType

string

(Optional) Specify the pair type of the pairs about which information is to be obtained.

  • TC: TrueCopy
  • UR: Universal Replicator
  • GAD: global-active device
Body

None.

Response message

Body
{
    "data": [
        {
            "remoteReplicationId": "R9,10088,375,R9,10011,969",
            "muNumber": 2,
            "replicationType": "UR",
            "pvolLdevId": 375,
            "svolLdevId": 969,
            "fenceLevel": "ASYNC",
            "pvolJournalId": 10,
            "svolJournalId": 0,
            "pvolStatus": "PAIR",
            "consistencyGroupId": 17,
            "pvolStorageType": "R9",
            "pvolStorageSerial": "10088",
            "svolStorageType": "R9",
            "svolStorageSerial": "10011",
            "transitionStatus": "None",
            "pathGroupId": 0
        },
        {
            "remoteReplicationId": "R9,10088,378,R9,10011,765",
            "replicationType": "TC",
            "pvolLdevId": 378,
            "svolLdevId": 765,
            "fenceLevel": "DATA",
            "pvolStatus": "PAIR",
            "pvolStorageType": "R9",
            "pvolStorageSerial": "10088",
            "svolStorageType": "R9",
            "svolStorageSerial": "10011", 
            "copyPace": 3,
            "pathGroupId": 0
        },
        {
            "remoteReplicationId": "R9,10088,400,R9,10011,567",
            "muNumber": 0,
            "replicationType": "GAD",
            "pvolLdevId": 400,
            "svolLdevId": 567,
            "fenceLevel": "NEVER",
            "quorumDiskId": 4,
            "pvolStatus": "PAIR",
            "consistencyGroupId": 11,
            "pvolIOMode": "L/M",
            "pvolStorageType": "R9",
            "pvolStorageSerial": "10088",
            "svolStorageType": "R9",
            "svolStorageSerial": "10011",
            "copyPace": 7,
            "pathGroupId": 0
        }
    ]
}

Attribute

Type

Description

remoteReplicationId

string

Object ID of the remote copy pair

The following attributes are output, separated by commas:

  • pvolStorageType
  • pvolStorageSerial
  • pvolLdevId
  • svolStorageType
  • svolStorageSerial
  • svolLdevId

If the value of remoteReplicationId includes Unknown or -1, the pair might not be in a normal state. Check the status of the storage system.

muNumber

int

MU (mirror unit) number

replicationType

string

Pair type

  • TC: TrueCopy
  • UR: Universal Replicator
  • GAD: global-active device

pvolLdevId

int

LDEV number of P-VOL

svolLdevId

int

LDEV number of S-VOL

fenceLevel

string

Fence level
  • DATA: S-VOL data
  • STATUS: S-VOL status
  • NEVER: None
  • ASYNC: Asynchronous

If the fence level cannot be obtained, information is not output.

pvolJournalId

int

Journal ID of the P-VOL

A value from 0 to 255 is output only in the case of Universal Replicator.

svolJournalId

int

Journal ID of the S-VOL

A value from 0 to 255 is output only in the case of Universal Replicator.

quorumDiskId

int

ID of the Quorum disk

A value from 0 to 31 is output only in the case of global-active device.

pvolStatus

string

Pair volume status of the P-VOL

This attribute is output only if the specified storage system contains the P-VOL.

For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

svolStatus

string

Pair volume status of the S-VOL

This attribute is output only if the specified storage system contains the S-VOL.

For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

consistencyGroupId

int

Consistency group ID

This attribute is not output if no consistency group consists.

pvolIOMode

string

I/O mode of the P-VOL
  • L/M: Mirror (RL)
  • L/L: Local
  • B/B: Block

This is output only if the volume is a global-active device and the specified storage system is on the P-VOL.

svolIOMode

string

I/O mode of the S-VOL
  • L/M: Mirror (RL)
  • L/L: Local
  • B/B: Block

This is output only if the volume is a global-active device and the specified storage system is on the S-VOL.

pvolStorageType

string

ID indicating the model of the storage system on the P-VOL

  • R8: VSP G1000, VSP G1500, or VSP F1500

  • R9: VSP 5000 series
  • M8: VSP E series, VSP Gx00 models, VSP Fx00 models
  • UNKNOWN: Unknown

pvolStorageSerial

string

Serial number of the storage system on the P-VOL

svolStorageType

string

ID indicating the model of the storage system on the S-VOL

  • R8: VSP G1000, VSP G1500, or VSP F1500

  • R9: VSP 5000 series
  • M8: VSP E series, VSP Gx00 models, VSP Fx00 models
  • UNKNOWN: Unknown

svolStorageSerial

string

Serial number of the storage system on the S-VOL

transitionStatus

string

The transition status of a pair is output for a Universal Replicator pair.

  • None: The pair is not in transition.
  • Suspending: The pair is being split.
  • Deleting: The pair is being deleted.

This is not output if the copy pair is not a Universal Replicator pair.

copyPace

int

Copy speed

If the pair type is TrueCopy, this attribute is output only if the specified storage system contains the P-VOL.

If the pair type is global-active device, this attribute is output regardless of whether the specified storage system contains the P-VOL or contains the S-VOL.

This is not output if the pair type is Universal Replicator.

pathGroupId

int

Path group ID of the RCU

This is not output if CU is specified for the remote path connection setting.

deltaStatus

string

Status of the 3DC multi-target configuration that uses delta resync

This is output if the pair type is Universal Replicator and the 3DC multi-target configuration that uses delta resync is used.

  • HOLD: Universal Replicator delta resync pair (normal)
  • HLDE: Universal Replicator delta resync pair (failed)
  • HOLDING: In the process of being changed to a Universal Replicator delta resync pair

Status codes

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

Coding example

curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-replications