Gnr/recoverygroups/{recoveryGroupName}/vdisks/{vdiskName}: GET

Returns the details a virtual disk that is available in a specified recovery group.

Availability

Available with the Elastic Storage Server.

Description

The GET gnr/recoverygroup/{recoveryGroupName}/vdisks/{vdiskName} request gets the details of a specific vdisk that is part of a particular recovery group. For more information about the fields in the data structures that are returned, see mmlsvdisk command.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/recoverygroups/recoveryGroupName/vdisks/vdiskName
where
gnr/recoverygroups/recoveryGroupName
Specifies a particular recovery group that contains the vdisk. Required.
/vdisks/vdiskName
Specifies a particular vdisk as 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. Optional.
filter Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET' Optional.
recoveryGroupName The name of the recovery group that contains the vdisk. Required.
vdiskName The name of the vdisk about which you need the details. Required.

Request data

No request data.

Response data

{  
   "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   },
    "paging": 
    {
    "next": "URL"
    },
   "vdisks": [
      {
          
            "name":"Name",
            "recoveryGroup":"Recovery group",
            "declusteredArray":"Declustered array",
            "size":"Size",
            "raidCode":"RAID code"
            "trackSize":"Track size",
            "checksumGranularity":"Checksum granularity",
            "remarks":"Remarks",
            "state":"State",
            "healthState":"Health status",
            "oid":"ID",
  }
 ]
}
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.
"vdisks":"Virtual disk details"
Array of information that lists the details of the vdisk that is available in the specified recovery group.
"name":"Name",
Name of the vdisk.
"recoveryGroup":"Recovery group"
The name of the recovery group of the vdisk.
"declusteredArray":"Declustered array"
The name of the declustered array of the vdisk.
"size":"Size"
Size of the vdisk.
"raidCode":"RAID code"
RAID code of the vdisk.
"trackSize":"Track size"
Size of the track.
"checksumGranularity":"Checksum granularity"
The granularity of checksum.
"remarks":"Remarks"
Remarks about the vdisk.
"state":"State"
The state of the vdisk.
"healthState":"Health status"
The health status of the vdisk.
"oid":"ID"
The ID used for paging.

Examples

The following example gets information about the vdisk vdisk1 that is available in the recovery group RG1.

Request data:
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/recoverygroups/RG1/vdisks/vdisk1
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/filesystems/gpfs0/filesets?lastId=1001"
  },
  "vdisks": [
    {
      "name": "vdisk1",
      "recoveryGroup": "RG1",
      "declusteredArray": "DA1",
      "size": 262144,
      "raidCode": "2WayReplication",
      "trackSize": 262144,
      "checksumGranularity": 32768,
      "remarks": "logTip",
      "state": "ok",
      "healthState": "UNKNOWN",
      "oid": 0
    }
  ]
}