Recoverygroups/declusteredArray: GET

Gets information on a list of declustered array for all the recovery groups.

Availability

Available on Elastic Storage Server and IBM Storage Scale Erasure Code editions.

Description

The GET scalemgmt/v2/gnr/recoverygroups/declusteredArray request gets information on a list of declustered array for all the recovery groups in the cluster. For more information about the fields in the data structures that are returned, see the mmvdisk recoverygroup command.

Request URL

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

Request headers

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

Request data

No request data.

Response data


  {
  "status": {
    "code": Status code,
    "message": "Status message"
  },  "stdout": [
     "declusteredArray": [
    {
      "active": "yes |no ",
      "bgTask": "string",
      "bgTaskPctComplete": "string",
      "daName": "Declustered Array name",
      "freeSpace": Free space available 
      "hwType": "Hardware type" 
      "mmvdiskControlled": "yes | no"
      "needsService": "yes | no"
      "numPdisk": Number of Pdisks
      "numSpares": Number of spare disks
      "pctFree": Integer
      "rgName": "Recovery group name"
      "rgType": "recovery group type"
      "totalSpace": "Total space available"
      "trimDevice": "yes | no"
    }
    ],
   ]
}
"status":
Return status.
"message": "ReturnMessage"
The return message.
"code": ReturnCode
The return code.
"stdout":"CLI messages"
The CLI messages from stdout.
"declusteredArray"
An array that comprises details on the jobs that were run.
"active": yes | no
Specifies whether the declustered array is in an active state.
"bgTask": Task name
The background task that is running in the declustered array.
"bgTaskPctComplete": Integer
The percentage of completion of the background task.
"daName": Declustered array name
The name of the declustered array.
"freeSpace": Space available
The amount of free space available.
"hwType": Hardware type
The supported hardware type.
"mmvdiskControlled": yes | no
Specifies whether the declustered array belongs to an mmvdisk recovery group.
"needsService": yes | no
Specifies whether the declustered array requires maintenance services.
"numPdisk": Integer
The number of physical disks (disk) available in the declustered array.
"numSpares": Integer
The spare disk space that is reserved for rebuilding the data.
"pctFree": Integer
The percentage of space that is remaining in the declustered array after the vdisk is created.
"rgName": Recovery group name
The name of the recovery group to which the declustered array belongs.
"rgType": Recovery group type
The type of the recovery group to which the declustered array belongs.
"total space": Total space available
The total space available in the declustered array.
"trimDevice": yes | no
Specifies whether the trim function is enabled for the declustered array.

Examples

The following example gets information on the declustered array DA1.

Request data:
curl -X GET --header 'Accept: application/json' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/recoverygroups/declusteredArray
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. 

{ 
  "stdout": {
  "declusteredArrayList": [
    {
      "active": "yes",
      "bgTask": "scrub",
      "bgTaskPctComplete": 47,
      "daName": "DA1",
      "freeSpace": 0,
      "hwType": "HDD",
      "mmvdiskControlled": "yes",
      "needsService": "yes",
      "numPdisk": 0,
      "numSpares": 2,
      "pctFree": 32,
      "rgName": "rg1",
      "rgType": "scale-out",
      "totalSpace": 0,
      "trimDevice": "no"
    }
  ],
  "status": {
    "code": 200,
    "message": "The request finished successfully."
  }
}