Retrieve ONTAP Mediators configured in the cluster
Retrieves mediators configured in the cluster to manage and monitor the high availability of storage systems. This endpoint helps you ensure that your cluster maintains optimal performance and reliability.
HTTP method and endpoint
GET /cluster/mediators
Introduced in
ONTAP 9.8
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
peer_cluster.uuid |
string |
query |
False |
Filter by peer_cluster.uuid |
peer_cluster.name |
string |
query |
False |
Filter by peer_cluster.name |
peer_mediator_connectivity |
string |
query |
False |
Filter by peer_mediator_connectivity
|
ip_address |
string |
query |
False |
Filter by ip_address |
port |
integer |
query |
False |
Filter by port |
reachable |
boolean |
query |
False |
Filter by reachable |
uuid |
string |
query |
False |
Filter by uuid |
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_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",
"peer_cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster2",
"uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
},
"peer_mediator_connectivity": "connected",
"port": 31784,
"reachable": 1,
"uuid": "string"
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
||
self |
dr_group
DR group reference.
| Name | Type | Description |
|---|---|---|
id |
integer |
DR Group ID |
_links
| Name | Type | Description |
|---|---|---|
self |
peer_cluster
The peer cluster that the mediator service is used for.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
records
| Name | Type | Description |
|---|---|---|
dr_group |
DR group reference. |
|
ip_address |
string |
The IP address of the mediator. |
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. |
uuid |
string |
The unique identifier for the mediator service. |
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. |