Skip to main content

Retrieve MetroCluster nodes and configurations

Contributors
PDFs

GET /cluster/metrocluster/nodes

Introduced In: 9.8

Retrieves MetroCluster nodes and their configurations.

  • metrocluster node show

Learn more

Parameters

Name Type In Required Description

dr_group_id

integer

query

False

Filter by dr_group_id

cluster.uuid

string

query

False

Filter by cluster.uuid

cluster.name

string

query

False

Filter by cluster.name

node.name

string

query

False

Filter by node.name

node.system_id

string

query

False

Filter by node.system_id

  • Introduced in: 9.12

node.uuid

string

query

False

Filter by node.uuid

dr_auxiliary_cluster.uuid

string

query

False

Filter by dr_auxiliary_cluster.uuid

  • Introduced in: 9.12

dr_auxiliary_cluster.name

string

query

False

Filter by dr_auxiliary_cluster.name

  • Introduced in: 9.12

dr_partner.name

string

query

False

Filter by dr_partner.name

  • Introduced in: 9.12

dr_partner.system_id

string

query

False

Filter by dr_partner.system_id

  • Introduced in: 9.12

dr_partner.uuid

string

query

False

Filter by dr_partner.uuid

  • Introduced in: 9.12

dr_partner_cluster.uuid

string

query

False

Filter by dr_partner_cluster.uuid

  • Introduced in: 9.12

dr_partner_cluster.name

string

query

False

Filter by dr_partner_cluster.name

  • Introduced in: 9.12

ha_partner.name

string

query

False

Filter by ha_partner.name

  • Introduced in: 9.12

ha_partner.system_id

string

query

False

Filter by ha_partner.system_id

  • Introduced in: 9.12

ha_partner.uuid

string

query

False

Filter by ha_partner.uuid

  • Introduced in: 9.12

limit_enforcement

string

query

False

Filter by limit_enforcement

  • Introduced in: 9.12

ha_partner_cluster.uuid

string

query

False

Filter by ha_partner_cluster.uuid

  • Introduced in: 9.12

ha_partner_cluster.name

string

query

False

Filter by ha_partner_cluster.name

  • Introduced in: 9.12

dr_auxiliary_partner.name

string

query

False

Filter by dr_auxiliary_partner.name

  • Introduced in: 9.12

dr_auxiliary_partner.system_id

string

query

False

Filter by dr_auxiliary_partner.system_id

  • Introduced in: 9.12

dr_auxiliary_partner.uuid

string

query

False

Filter by dr_auxiliary_partner.uuid

  • Introduced in: 9.12

dr_mirroring_state

string

query

False

Filter by dr_mirroring_state

automatic_uso

boolean

query

False

Filter by automatic_uso

  • Introduced in: 9.9

is_mccip

boolean

query

False

Filter by is_mccip

  • Introduced in: 9.12

dr_operation_state

string

query

False

Filter by dr_operation_state

  • Introduced in: 9.9

configuration_state

string

query

False

Filter by configuration_state

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

collection_links

num_records

integer

Number of Records

records

array[metrocluster_node]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "unreachable",
    "dr_auxiliary_cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "dr_auxiliary_partner": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "system_id": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "dr_group_id": 0,
    "dr_mirroring_state": "enabled",
    "dr_operation_state": "normal",
    "dr_partner": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "system_id": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "dr_partner_cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "ha_partner": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "system_id": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "ha_partner_cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "limit_enforcement": "enabled",
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "system_id": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  }
}

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.

Also see the table of common errors in the Response body overview section of this documentation.

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
Name Type Description

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

cluster

Name Type Description

_links

_links

name

string

uuid

string

dr_auxiliary_cluster

DR AUX cluster.

Name Type Description

_links

_links

name

string

uuid

string

dr_auxiliary_partner

AUX partner node.

Name Type Description

_links

self_link

name

string

system_id

string

uuid

string

dr_partner

DR partner node.

Name Type Description

_links

self_link

name

string

system_id

string

uuid

string

dr_partner_cluster

DR partner cluster.

Name Type Description

_links

_links

name

string

uuid

string

ha_partner

HA partner node.

Name Type Description

_links

self_link

name

string

system_id

string

uuid

string

ha_partner_cluster

HA partner cluster.

Name Type Description

_links

_links

name

string

uuid

string

node

Name Type Description

_links

self_link

name

string

system_id

string

uuid

string

metrocluster_node

Data for a node in a MetroCluster. REST: /api/cluster/metrocluster/nodes

Name Type Description

_links

self_link

automatic_uso

boolean

Specifies if automatic unplanned switchover is enabled.

cluster

cluster

configuration_state

string

Configuration state of the node.

dr_auxiliary_cluster

dr_auxiliary_cluster

DR AUX cluster.

dr_auxiliary_partner

dr_auxiliary_partner

AUX partner node.

dr_group_id

integer

DR Group ID.

dr_mirroring_state

string

State of the DR mirroring configuration.

dr_operation_state

string

State of the DR operation.

dr_partner

dr_partner

DR partner node.

dr_partner_cluster

dr_partner_cluster

DR partner cluster.

ha_partner

ha_partner

HA partner node.

ha_partner_cluster

ha_partner_cluster

HA partner cluster.

is_mccip

boolean

Indicates whether the configuration type is MCC-IP.

limit_enforcement

string

Indicates if the node object limits are enforced.

node

node

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.