Getting TrueCopy or Universal Replicator pair 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

You can obtain a list of volume and storage system information regarding the P-VOL and S-VOL composing a TrueCopy or Universal Replicator pair. You can obtain the pair information without specifying information about the remote storage system in the request message.

Execution permission

Administrator user group (built-in user group)

Request line

GET base-URL/v1/objects/remote-copypairs

Request message

Object ID: None.

Query parameters

Parameter	Type	Filter Condition
replicationType	string	(Required) Specify the pair type. `TC`: TrueCopy `UR`: Universal Replicator
headLdevId	int	(Optional) Specify, as a decimal (base 10) number, the number of the first LDEV for which you want to acquire information about the pair. Specify a value in the range from `0` to `65279`. If this attribute is omitted, `0` is set.
count	int	(Optional) Specify the number of LDEVs about which information is to be obtained. Specify this by a decimal (base 10) number. Specify a value in the range from `0` to `500`. If this attribute is omitted, `500` is set.

Parameter

Type

Filter Condition

replicationType

string

(Required) Specify the pair type.

TC: TrueCopy
UR: Universal Replicator

headLdevId

int

(Optional) Specify, as a decimal (base 10) number, the number of the first LDEV for which you want to acquire information about the pair.

Specify a value in the range from 0 to 65279.

If this attribute is omitted, 0 is set.

count

int

(Optional) Specify the number of LDEVs about which information is to be obtained. Specify this by a decimal (base 10) number.

Specify a value in the range from 0 to 500.

If this attribute is omitted, 500 is set.

Body: None.

Response message

Body

{
  "data" : [ {
    "replicationType" : "TC",
    "ldevId" : 49153,
    "remoteSerialNumber" : "10088",
    "remoteStorageTypeId" : "R9",
    "remoteLdevId" : 51712,
    "primaryOrSecondary" : "P-VOL",
    "muNumber" : 0,
    "status" : "PSUS",
    "serialNumber" : "10011",
    "storageTypeId" : "R9",
    "isMainframe" : false
  } ]
}

Attribute	Type	Description
replicationType	string	Pair type `TC`: TrueCopy `UR`: Universal Replicator
ldevId	int	LDEV number of the volume on the local storage system.
remoteSerialNumber	string	Serial number of the remote storage system
remoteStorageTypeId	string	ID corresponding to the model of the remote storage system `R8`: VSP G1000, VSP G1500, or VSP F1500 `R9`: VSP 5000 series `M8`: VSP E series, VSP Gx00 models or VSP Fx00 models
remoteLdevId	int	LDEV number of the volume on the remote storage system
primaryOrSecondary	string	Attribute of the volume on the local storage system `P-VOL` `S-VOL`
muNumber	int	MU number
status	string	Pair status of the volume on the local storage system For details, see the section about pair status transition (TrueCopy and Universal Replicator).
serialNumber	string	Serial number of the local storage system
storageTypeId	string	ID indicating the model of the local storage system `R9`: VSP 5000 series `M8`: VSP E series, VSP Gx00 models or VSP Fx00 models
isMainframe	boolean	Whether the pair is for mainframe use `true`: Pair for mainframe use `false`: Not a pair for mainframe use

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 "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-copypairs?replicationType=TC