Skip to main content

Retrieve the status of all SnapMirror relationships

GET /replication/status

Retrieves the status of all SnapMirror relationships.

Parameters

Name Type In Required Description

tenantId

string

query

False

Error

Status: Default, Default response
Name Type Required Description

currentTransferInfo

ReplicationStatusCurrentTransferInfo

True

destination

ReplicationStatusSide

True

healthy

boolean

True

SnapMirror health

lagTime

Duration

True

lastTransferInfo

ReplicationStatusLastTransferInfo

True

maxTransferRate

Capacity

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

Capacity

True

relationshipStatus

string

True

SnapMirror relationship status

relationshipType

string

True

SnapMirror relationship type

schedule

string

True

Schedule name

source

ReplicationStatusSide

True

totalTransferSize

Capacity

True

totalTransferTime

Duration

True

unhealthyReason

string

True

The reason SnapMirror is unhealthy

volumeCapacityTier

Capacity

True

volumeUsedSize

Capacity

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": {
      "size": 0,
      "unit": "string"
    },
    "transferType": "string"
  },
  "maxTransferRate": {
    "size": 0,
    "unit": "string"
  },
  "mirrorState": "string",
  "networkCompressionRatio": "string",
  "newestSnapshotCreated": "string",
  "newestSnapshotName": "string",
  "policy": "string",
  "policyType": "string",
  "relationshipProgress": {
    "size": 0,
    "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": {
    "size": 0,
    "unit": "string"
  },
  "totalTransferTime": {
    "unit": "string"
  },
  "unhealthyReason": "string",
  "volumeCapacityTier": {
    "size": 0,
    "unit": "string"
  },
  "volumeUsedSize": {
    "size": 0,
    "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

True

Size

unit

string

True

Unit

ReplicationStatusLastTransferInfo

Name Type Required Description

transferDuration

Duration

True

transferEnded

string

True

Last transfer end time

transferError

string

True

Last transfer error

transferSize

Capacity

True

transferType

string

True

Last transfer type