Skip to main content

Retrieve a list of ONTAP relationships associated with a system

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

Retrieves a list of ONTAP relationships associated with a system. The system ID is passed as a parameter for the REST API call. You can query by passing parameters to specify the maximum number of records that should be returned, the next subsequent volume UUID to get results from, and the type of relationship.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

max-records

number

query

False

cursor

string

query

False

accountId

string

path

True

workingEnvironmentId

string

path

True

authorization

string

header

True

X-Agent-Id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

relationship

array[relationship]

False

cursor

string

False

num-records

number

False
Example response 
{
  "relationship": [
    {
      "uuid": "string",
      "source": {
        "path": "string",
        "svm": "string"
      },
      "destination": {
        "path": "string"
      },
      "policy": {
        "name": "string"
      },
      "state": "string",
      "healthy": "string",
      "relationship-type": "string",
      "transfer": {
        "last-transfer-size": "string",
        "last-transfer-duration": "string",
        "lag": "string",
        "end-time": "string",
        "state": "string",
        "throttle": "string"
      },
      "protection-status": "string",
      "unhealthy-reason": "string",
      "working-environment-id": "string",
      "working-environment-name": "string"
    }
  ],
  "cursor": "string"
}

Definitions

See Definitions

source

Name Type Required Description

path

string

False

svm

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

relationship

Name Type Required Description

uuid

string

False

source

source

False

destination

destination

False

policy

policy

False

state

string

False

healthy

string

False

relationship-type

string

False

transfer

transfer

False

protection-status

string

False

unhealthy-reason

string

False

working-environment-id

string

False

working-environment-name

string

False