Skip to main content

List the relationship details associated with a volume SnapMirror replication

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId}

Lists the relationship details associated with a volume SnapMirror replication relationship. The API returns the source details, destination details, policy details, status, health, transfer type, and relationship status details.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

accountId

string

path

True

workingEnvironmentId

string

path

True

relationshipId

string

path

True

authorization

string

header

True

X-Agent-Id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

uuid

string

False

source

source

False

destination

destination

False

policy

policy

False

state

string

False

healthy

string

False

transfer

transfer

False

protection-status

string

False

working-environment-id

string

False

working-environment-name

string

False

Example response
{
  "uuid": "string",
  "source": {
    "path": "string"
  },
  "destination": {
    "path": "string"
  },
  "policy": {
    "name": "string"
  },
  "state": "string",
  "healthy": "string",
  "transfer": {
    "last-transfer-size": "string",
    "last-transfer-duration": "string",
    "lag": "string",
    "end-time": "string",
    "state": "string",
    "throttle": "string"
  },
  "protection-status": "string",
  "working-environment-id": "string",
  "working-environment-name": "string"
}

Definitions

See Definitions

source

Name Type Required Description

path

string

False

destination

Name Type Required Description

path

string

False

policy

Name Type Required Description

name

string

False

transfer

Name Type Required Description

last-transfer-size

string

False

last-transfer-duration

string

False

lag

string

False

end-time

string

False

state

string

False

throttle

string

False