Skip to main content
A newer release of this product is available.

Retrieve an SVM peer relationship instance

Contributors
PDFs

GET /svm/peers/{uuid}

Retrieves the SVM peer relationship instance.

  • vserver peer show

Example

Retrieves the parameters of an SVM peer relationship.

GET "/api/svm/peers/d3268a74-ee76-11e8-a9bb-005056ac6dc9"

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

SVM peer relation UUID

fields

array[string]

query

False

Specify the fields to return.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

Response

Status: 200, Ok
Name Type Description

_links

_links

applications

array[string]

A list of applications for an SVM peer relation.

name

string

A peer SVM alias name to avoid a name conflict on the local cluster.

peer

peer

Details for a peer SVM object.

state

string

SVM peering state. To accept a pending SVM peer request, PATCH the state to "peered". To reject a pending SVM peer request, PATCH the state to "rejected". To suspend a peered SVM peer relation, PATCH the state to "suspended". To resume a suspended SVM peer relation, PATCH the state to "peered". The states "initiated", "pending", and "initializing" are system-generated and cannot be used for PATCH.

svm

svm

Local SVM details

uuid

string

SVM peer relation UUID
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "applications": [
    "snapmirror",
    "lun_copy"
  ],
  "peer": {
    "cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster2",
      "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
    },
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  },
  "state": "peered",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "string"
}

Error

Status: Default

ONTAP Error Response Codes

Error codes Description

26345578

Internal error. Unable to retrieve local or peer SVM name.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

cluster

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

peer

Details for a peer SVM object.

Name Type Description

cluster

cluster

svm

svm

SVM, applies only to SVM-scoped objects.

svm

Local SVM details

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.