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

Retrieve configuration information for an SVM

PDFs

GET /cluster/metrocluster/svms/{cluster.uuid}/{svm.uuid}

Introduced In: 9.11

Retrieves configuration information for an SVM in a MetroCluster relationship.

Parameters

Name Type In Required Description

cluster.uuid

string

path

True

Cluster ID

svm.uuid

string

path

True

SVM UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

cluster

cluster

configuration_state

string

Configuration state.

failed_reason

error

Reason for SVM object replication failure.

partner_svm

partner_svm

svm

svm
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "cluster": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "configuration_state": "string",
  "failed_reason": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  },
  "partner_svm": {
    "name": "string",
    "uuid": "string"
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error
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

self

href

_links

Name Type Description

self

href

cluster

Name Type Description

_links

_links

name

string

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Reason for SVM object replication failure.

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.

partner_svm

Name Type Description

name

string

MetroCluster partner SVM name.

uuid

string

MetroCluster partner SVM UUID.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.