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

Retrieve diagnostic operation results for a MetroCluster configuration

Contributors
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

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

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Response

Status: 200, Ok
Name Type Description

aggregate

aggregate

cluster

cluster

config-replication

config-replication

connection

connection

interface

interface

node

node

volume

volume
Example response 
{
  "aggregate": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  },
  "cluster": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  },
  "config-replication": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-14T14:35:16-08:00"
  },
  "connection": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  },
  "interface": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  },
  "node": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  },
  "volume": {
    "state": "string",
    "summary": {
      "code": "string",
      "message": "string"
    },
    "timestamp": "2016-03-10T14:35:16-08:00"
  }
}

Error

Status: Default

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

2427132

MetroCluster is not configured on this cluster.

2432856

MetroCluster diagnostics result is not available. Use the REST API GET method on "/api/cluster/metrocluster/operations?type=check&fields=*" for more information.

Definitions

See Definitions

summary

Additional information or recovery steps to take.

Name Type Description

code

string

Argument code

message

string

Message argument

aggregate

Name Type Description

state

string

Status of diagnostic operation for this component.

summary

summary

Additional information or recovery steps to take.

timestamp

string

Time of the most recent diagnostic operation for this component

cluster

Name Type Description

state

string

Status of diagnostic operation for this component.

summary

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

summary

Additional information or recovery steps to take.

timestamp

string

Time of the most recent diagnostic operation for this component

connection

Name Type Description

state

string

Status of diagnostic operation for this component.

summary

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

summary

Additional information or recovery steps to take.

timestamp

string

Time of the most recent diagnostic operation for this component

node

Name Type Description

state

string

Status of diagnostic operation for this component.

summary

summary

Additional information or recovery steps to take.

timestamp

string

Time of the most recent diagnostic operation for this component

volume

Name Type Description

state

string

Status of diagnostic operation for this component.

summary

summary

Additional information or recovery steps to take.

timestamp

string

Time of the most recent diagnostic operation for this component