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

Retrieve DR group information using the DR group ID

Contributors
PDFs

GET /cluster/metrocluster/dr-groups/{id}

Introduced In: 9.8

Retrieves the DR group information specified by the DR group id.

Parameters

Name Type In Required Description

id

string

path

True

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

dr_pairs

array[dr_pair]

id

integer

DR Group ID

partner_cluster

partner_cluster

Partner cluster information.
Example response 
{
  "dr_pairs": {
    "node": {
      "name": "nodeA"
    },
    "partner": {
      "name": "nodeB"
    }
  },
  "id": 0,
  "partner_cluster": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

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

node

Local node of the DR Group.

Name Type Description

name

string

Name of the node.

partner

Partner node of the DR Group.

Name Type Description

name

string

Name of the node.

dr_pair

Name Type Description

node

node

Local node of the DR Group.

partner

partner

Partner node of the DR Group.

href

Name Type Description

href

string

_links

Name Type Description

self

href

partner_cluster

Partner cluster information.

Name Type Description

_links

_links

name

string

uuid

string

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.