Retrieve the status of all SnapMirror relationships
Retrieves the status of all SnapMirror relationships. Use this to monitor the replication state and health of your data protection configurations.
HTTP method and endpoint
GET /replication/status
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
tenantId |
string |
query |
False |
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 |
Example error response
{
"currentTransferInfo": {
"transferError": "string",
"transferPriority": "string",
"transferType": "string"
},
"destination": {
"availabilityZone": "string",
"clusterName": "string",
"nodeName": "string",
"region": "string",
"svmName": "string",
"svmPeerAliasName": "string",
"volumeName": "string",
"workingEnvironmentId": "string",
"workingEnvironmentStatus": "string",
"workingEnvironmentType": "string"
},
"healthy": false,
"lagTime": {
"unit": "string"
},
"lastTransferInfo": {
"transferDuration": {
"unit": "string"
},
"transferEnded": "string",
"transferError": "string",
"transferSize": {
"unit": "string"
},
"transferType": "string"
},
"maxTransferRate": {
"unit": "string"
},
"mirrorState": "string",
"networkCompressionRatio": "string",
"newestSnapshotCreated": "string",
"newestSnapshotName": "string",
"policy": "string",
"policyType": "string",
"relationshipProgress": {
"unit": "string"
},
"relationshipStatus": "string",
"relationshipType": "string",
"schedule": "string",
"source": {
"availabilityZone": "string",
"clusterName": "string",
"nodeName": "string",
"region": "string",
"svmName": "string",
"svmPeerAliasName": "string",
"volumeName": "string",
"workingEnvironmentId": "string",
"workingEnvironmentStatus": "string",
"workingEnvironmentType": "string"
},
"totalTransferSize": {
"unit": "string"
},
"totalTransferTime": {
"unit": "string"
},
"unhealthyReason": "string",
"volumeCapacityTier": {
"unit": "string"
},
"volumeUsedSize": {
"unit": "string"
}
}
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 |
False |
|
unit |
string |
False |
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 |