REST API reference
Retrieve diagnostic operation results for a MetroCluster configuration
Suggest changes
PDFs
GET /cluster/metrocluster/diagnostics
Introduced In: 9.8
Retrieves the results of a completed diagnostic operation for the MetroCluster configuration.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
aggregate |
||
cluster |
||
config-replication |
||
connection |
||
interface |
||
node |
||
volume |
Example response
{
"aggregate": {
"details": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"checks": [
{
"additional_info": {
"code": "string",
"message": "string"
},
"name": "mirrror_status",
"result": "string"
}
],
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"timestamp": "2016-03-10 17:35:16 -0500",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
],
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
},
"cluster": {
"details": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"checks": [
{
"additional_info": {
"code": "string",
"message": "string"
},
"name": "mirrror_status",
"result": "string"
}
],
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"timestamp": "2016-03-10 17:35:16 -0500",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
],
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
},
"config-replication": {
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-14 18:35:16 -0400"
},
"connection": {
"details": [
{
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"connections": [
{
"destination_address": "string",
"partner": {
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"type": "string"
},
"port": "string",
"result": "string",
"source_address": "string",
"state": "string"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
],
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
},
"interface": {
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
},
"node": {
"details": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"checks": [
{
"additional_info": {
"code": "string",
"message": "string"
},
"name": "mirrror_status",
"result": "string"
}
],
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"timestamp": "2016-03-10 17:35:16 -0500",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
],
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
},
"volume": {
"details": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"checks": [
{
"additional_info": {
"code": "string",
"message": "string"
},
"name": "mirrror_status",
"result": "string"
}
],
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"timestamp": "2016-03-10 17:35:16 -0500",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
],
"state": "string",
"summary": {
"code": "string",
"message": "string"
},
"timestamp": "2016-03-10 17:35:16 -0500"
}
}Error
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
2425734 |
An internal error occurred. Wait a few minutes, and try the operation again. For further assistance, contact technical support. |
2426405 |
MetroCluster is not configured in cluster "cluster". Run "metrocluster show" to verify both the local and the remote clusters are configured as MetroCluster, and then try the command again. |
2432856 |
MetroCluster diagnostics result is not available. Use the REST API GET method on "/api/cluster/metrocluster/operations?type=check&fields=*" for more information. |
Also see the table of common errors in the Response body overview section of this documentation.
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
aggregate
Aggregate
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
additional_info
Additional information or recovery steps to take on this component.
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
metrocluster_diag_check
Generic object which can be used for various components which holds details of the checks of a component.
| Name | Type | Description |
|---|---|---|
additional_info |
Additional information or recovery steps to take on this component. |
|
name |
string |
Name of type of diagnostic operation run for the component. |
result |
string |
Result of the diagnostic operation on this component. |
cluster
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
volume
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a POST or PATCH method. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
metrocluster_diag_details
| Name | Type | Description |
|---|---|---|
aggregate |
Aggregate |
|
checks |
array[metrocluster_diag_check] |
Collection of MetroCluster checks done for component. |
cluster |
||
node |
||
timestamp |
string |
Time check was done. |
volume |
summary
Additional information or recovery steps to take.
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
aggregate
| Name | Type | Description |
|---|---|---|
details |
array[metrocluster_diag_details] |
Display details of the MetroCluster check for aggregates. |
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
cluster
| Name | Type | Description |
|---|---|---|
details |
array[metrocluster_diag_details] |
Display details of the MetroCluster check for clusters. |
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
config-replication
| Name | Type | Description |
|---|---|---|
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
partner
| Name | Type | Description |
|---|---|---|
node |
||
type |
string |
metrocluster_diag_connection
| Name | Type | Description |
|---|---|---|
destination_address |
string |
|
partner |
||
port |
string |
|
result |
string |
Result of the diagnostic operation on this component. |
source_address |
string |
|
state |
string |
metrocluster_diag_connection_details
| Name | Type | Description |
|---|---|---|
cluster |
||
connections |
array[metrocluster_diag_connection] |
|
node |
connection
| Name | Type | Description |
|---|---|---|
details |
Display details of the MetroCluster check for connections. |
|
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
interface
| Name | Type | Description |
|---|---|---|
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
node
| Name | Type | Description |
|---|---|---|
details |
array[metrocluster_diag_details] |
Displays details of the MetroCluster check for nodes. |
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |
volume
| Name | Type | Description |
|---|---|---|
details |
array[metrocluster_diag_details] |
Display details of the MetroCluster check for volumes. |
state |
string |
Status of diagnostic operation for this component. |
summary |
Additional information or recovery steps to take. |
|
timestamp |
string |
Time of the most recent diagnostic operation for this component |