Gnr/recoverygroups: GET

Gets a list of recovery groups that are configured in the cluster.

Availability

Available with the Elastic Storage Server.

Description

The GET gnr/recoverygroups request gets a list of recovery groups that are configured in the cluster. For more information about the fields in the data structures that are returned, see mmlsrecoverygroup command.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/recoverygroups
where
gnr/recoverygroups
Specifies that recovery groups are the resource of this GET call. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
fields Comma-separated list of fields to be included in response. ':all:' selects all available fields.  
filter Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'  

Request data

No request data.

Response data

{  
   "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   },
    "paging": 
    {
    "next": "URL"
    },
   "recoveryGroups": [
      {
            "name":"Name"
            "declusteredArrayCount":"Number",
            "capacity":"Capacity",
            "freeSpace":"Available space",
            "usedSpace":"Used space",
            "nodes":"List of nodes"
            "oid":"ID",
            "vdiskCount":"Number of Vdisks",
            "pdiskCount":"Number of Pdisks",
      }
   ]
}
For more information about the fields in the following data structures, see the links at the end of this topic.
"status":
Return status.
"message": "ReturnMessage"
The return message.
"code": ReturnCode
The return code.
"paging"
The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.
"recoveryGroups":
Details of the recovery group.
"name":"Name"
The name of the recovery group.
"declusteredArrayCount":"Number"
Number of declustered arrays present in the recovery group.
"capacity":"Capacity"
Capacity of the recovery group.
"freeSpace":"Available space"
Available space that is left in the recovery group.
"usedSpace":"Used space"
The space used in the recovery group.
"nodes":"List of nodes"
The nodes that are part of the recovery group.
"oid":"ID"
The internal identifier of the recovery group that is used for paging.
"vdiskCount":"Number of Vdisks"
Number of Vdisks that are part of the recovery group.
"pdiskCount":"Number of Pdisks"
Number of Pdisks that are part of the recovery group.

Examples

The following example gets information about the recovery groups that are configured in the cluster.

Request data:
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/recoverygroups
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 


{
  "status": {
    "code": 200,
    "message": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/gnr/recoverygroups"
  },
  "recoveryGroups": [
    {
      "name": "RG1",
      "declusteredArrayCount": 2,
      "capacity": 12878459437056,
      "freeSpace": 0,
      "usedSpace": 0,
      "nodes": ["node1"],
      "oid": 0,
      "vdiskCount": 0,
      "pdiskCount": 24
    }
  ]
}