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

Retrieve ONTAP Mediator state and configuration

Contributors
PDFs

GET /cluster/mediators/{uuid}

Introduced In: 9.8

Retrieves the mediator state and configuration.

Parameters

Name Type In Required Description

uuid

string

path

True

  • format: uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

ca_certificate

string

CA certificate for ONTAP Mediator. This is optional if the certificate is already installed.

  • x-ntap-createOnly: true

  • Introduced in: 9.8

  • x-nullable: true

dr_group

dr_group

DR group reference.

ip_address

string

The IP address of the mediator.

password

string

The password used to connect to the REST server on the mediator.

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.

port

integer

The REST server's port number on the mediator.

reachable

boolean

Indicates the connectivity status of the mediator.

user

string

The username used to connect to the REST server on the mediator.

uuid

string

The unique identifier for the mediator service.
Example response 
{
  "ca_certificate": "string",
  "dr_group": {
    "id": 0
  },
  "ip_address": "10.10.10.7",
  "password": "mypassword",
  "peer_cluster": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cluster2",
    "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
  },
  "peer_mediator_connectivity": "connected",
  "port": 31784,
  "reachable": 1,
  "user": "myusername",
  "uuid": "string"
}

Error

Status: Default, Error
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

dr_group

DR group reference.

Name Type Description

id

integer

DR Group ID

href

Name Type Description

href

string

_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

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.