Retrieve SnapMirror replication relationship status
GET /replication/status/{workingEnvironmentId}
Retrieves the SnapMirror replication relationship status of a specific system.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
workingEnvironmentId |
string |
path |
True |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
currentTransferInfo |
True |
||
destination |
True |
||
healthy |
boolean |
True |
SnapMirror health |
lagTime |
True |
||
lastTransferInfo |
True |
||
maxTransferRate |
True |
||
mirrorState |
string |
True |
SnapMirror status |
networkCompressionRatio |
string |
True |
Network compression ratio |
newestSnapshotCreated |
string |
True |
Newest snapshot creation time |
newestSnapshotName |
string |
True |
Newest snapshot name |
policy |
string |
True |
Policy name |
policyType |
string |
True |
Policy type |
relationshipProgress |
True |
||
relationshipStatus |
string |
True |
SnapMirror relationship status |
relationshipType |
string |
True |
SnapMirror relationship type |
schedule |
string |
True |
Schedule name |
source |
True |
||
totalTransferSize |
True |
||
totalTransferTime |
True |
||
unhealthyReason |
string |
True |
The reason SnapMirror is unhealthy |
volumeCapacityTier |
True |
||
volumeUsedSize |
True |
Definitions
See Definitions
ReplicationStatusCurrentTransferInfo
| Name | Type | Required | Description |
|---|---|---|---|
transferError |
string |
True |
Current transfer error |
transferPriority |
string |
True |
Current transfer priority |
transferType |
string |
True |
Current transfer type |
ReplicationStatusSide
| Name | Type | Required | Description |
|---|---|---|---|
availabilityZone |
string |
False |
AWS availability zone name |
clusterName |
string |
False |
Cluster name |
nodeName |
string |
False |
Node name |
region |
string |
False |
AWS region name |
svmName |
string |
False |
SVM name |
svmPeerAliasName |
string |
False |
SVM peer alias name |
volumeName |
string |
False |
Volume name |
workingEnvironmentId |
string |
False |
System ID |
workingEnvironmentStatus |
string |
False |
System status |
workingEnvironmentType |
string |
False |
System type |
Duration
| Name | Type | Required | Description |
|---|---|---|---|
length |
integer |
False |
Length |
unit |
string |
False |
Unit |
Capacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
True |
Size |
unit |
string |
True |
Unit |
ReplicationStatusLastTransferInfo
| Name | Type | Required | Description |
|---|---|---|---|
transferDuration |
True |
||
transferEnded |
string |
True |
Last transfer end time |
transferError |
string |
True |
Last transfer error |
transferSize |
True |
||
transferType |
string |
True |
Last transfer type |