Skip to main content
REST API reference

Retrieve ONTAP Mediators configured in the cluster

PDFs

GET /cluster/mediators

Introduced In: 9.8

"Retrieves a Mediator configured in the cluster."

  • storage iscsi-initiator show

Parameters

Name Type In Required Description

type

string

query

False

Filter by type

  • Introduced in: 9.17

peer_cluster.name

string

query

False

Filter by peer_cluster.name

peer_cluster.uuid

string

query

False

Filter by peer_cluster.uuid

local_mediator_connectivity

string

query

False

Filter by local_mediator_connectivity

  • Introduced in: 9.17

use_http_proxy_local

boolean

query

False

Filter by use_http_proxy_local

  • Introduced in: 9.17

uuid

string

query

False

Filter by uuid

port

integer

query

False

Filter by port

reachable

boolean

query

False

Filter by reachable

strict_cert_validation

boolean

query

False

Filter by strict_cert_validation

  • Introduced in: 9.17

peer_mediator_connectivity

string

query

False

Filter by peer_mediator_connectivity

  • Introduced in: 9.10

ip_address

string

query

False

Filter by ip_address

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "dr_group": {
        "id": 0
      },
      "ip_address": "10.10.10.7",
      "local_mediator_connectivity": "connected",
      "peer_cluster": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "cluster2",
        "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
      },
      "peer_mediator_connectivity": "connected",
      "port": 31784,
      "reachable": 1,
      "strict_cert_validation": 1,
      "type": "string",
      "use_http_proxy_local": 1,
      "use_http_proxy_remote": 1,
      "uuid": "string"
    }
  ]
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

2430739

Unable to access Mediator. Reason: Invalid Mediator IP or Mediator does not exist.
Name Type Description

error

returned_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

next

href

self

href

dr_group

DR group reference.

Name Type Description

id

integer

DR Group ID

_links

Name Type Description

self

href

peer_cluster

The peer cluster that the mediator service is used for.

Name Type Description

_links

_links

name

string

uuid

string

records

Mediator information

Name Type Description

dr_group

dr_group

DR group reference.

ip_address

string

The IP address of the mediator.

local_mediator_connectivity

string

Indicates the mediator connectivity status of the local cluster. Possible values are connected, unreachable, unusable and down-high-latency. This field is only applicable to the mediators in SnapMirror active sync configuration.

peer_cluster

peer_cluster

The peer cluster that the mediator service is used for.

peer_mediator_connectivity

string

Indicates the mediator connectivity status of the peer cluster. Possible values are connected, unreachable, unknown and down-high-latency.

port

integer

The REST server's port number on the mediator.

reachable

boolean

Indicates the connectivity status of the mediator.

strict_cert_validation

boolean

Indicates if strict validation of certificates is performed while making REST API calls to the mediator. This field is only applicable to the ONTAP Cloud Mediator.

  • Default value:

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

type

string

Mediator type. This field is only applicable to the mediators in SnapMirror active sync configuration.

use_http_proxy_local

boolean

Indicates if the local cluster should use an http-proxy server while making REST API calls to the mediator. This field is only applicable to the ONTAP cloud mediator.

  • Default value:

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

uuid

string

The unique identifier for the mediator service.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.