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

Retrieve MetroCluster operations on the local cluster

Contributors
PDFs

GET /cluster/metrocluster/operations

Introduced In: 9.8

Retrieves the list of MetroCluster operations on the local cluster.

  • metrocluster operation history show

Learn more

Parameters

Name Type In Required Description

end_time

string

query

False

Filter by end_time

command_line

string

query

False

Filter by command_line

start_time

string

query

False

Filter by start_time

errors

string

query

False

Filter by errors

type

string

query

False

Filter by type

state

string

query

False

Filter by state

additional_info

string

query

False

Filter by additional_info

node.uuid

string

query

False

Filter by node.uuid

  • Introduced in: 9.9

node.name

string

query

False

Filter by node.name

  • Introduced in: 9.9

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.

  • 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_operation]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "additional_info": "MetroCluster switchover with auto heal completed successfully.",
      "command_line": "metrocluster switchover",
      "end_time": "2016-03-10T14:35:16-08:00",
      "errors": [
        "siteB (warning): Unable to prepare the partner cluster for a pending switchback operation. Reason: entry doesn't exist. Reboot the nodes in the partner cluster before using the \"metrocluster switchback\" command."
      ],
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "start_time": "2016-03-10T14:33:16-08:00",
      "state": "completed_with_warnings",
      "type": "switchover",
      "uuid": "11111111-2222-3333-4444-abcdefabcdef"
    }
  ]
}

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

href

Name Type Description

href

string
Name Type Description

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

node

Node from where the command is executed.

Name Type Description

_links

_links

name

string

uuid

string

metrocluster_operation

Data for a MetroCluster operation. REST: /api/cluster/metrocluster/operations

Name Type Description

_links

self_link

additional_info

string

Additional information for the auto heal.

command_line

string

Command line executed with the options specified.

end_time

string

End Time

errors

array[string]

List of errors in the operation.

node

node

Node from where the command is executed.

start_time

string

Start Time

state

string

Indicates the state of the operation.

type

string

Name of the operation.

uuid

string

Identifier for the operation.

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.