/scalemgmt/v3/filesystems/{filesystem}/disks/{disk_name}: GET

Lists information about the specified disk in an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/disks/{disk_name} request retrieves the current configuration and state of a disk in a file system. This request can be run against mounted or unmounted file systems. For each disk in the list, this request displays the following information:
  • Disk name
  • Driver type
  • Logical sector size
  • Failure group
  • Indicates whether the disk holds data
  • Indicates whether the disk holds metadata
  • Status:
    • Ready: Normal status.
    • Suspended or To be emptied: Indicates that data is scheduled to be migrated off this disk.
    • Being emptied: Transitional status while a disk deletion is pending.
    • Emptied: Indicates that data has already been migrated off this disk.
    • Replacing: Transitional status for the old disk while a replacement is pending.
    • Replacement: Transitional status for the new disk while a replacement is pending.
  • Availability:
    • Up: The disk is available for normal read and write operations.
    • Down: Read and write operations cannot be done on this disk.
    • Recovering: Intermediate state when a disk is coming up. IBM Storage Scale verifies and corrects data during this process. Write operations can be done while the disk is in this state, but read operations cannot because the data on the recovering disk might be stale until the mmchdisk start command completes.
    • Unrecovered: The disk was not successfully brought up.
  • Disk ID
  • Storage pool: The storage pool to which the disk is assigned.
  • Remarks: A tag is displayed if the disk is a file system descriptor replica holder, an excluded disk, or if the disk supports space reclamation.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/disks/{disk_name}
where
{filesystem}
Specifies the name of the file system.
{disk_name}
Specifies the name of the disk.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystem The name of the file system. Required.
disk_name The name of the disk. Optional.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "auto_resume": true,
  "availability": "UP",
  "data": true,
  "desc_replica": true,
  "disk_usage": "DATA_AND_METADATA",
  "driver_type": "string",
  "excluded": true,
  "failure_group": "string",
  "filesystem": "string",
  "id": 0,
  "metadata": true,
  "name": "string",
  "remarks": "string",
  "sector_size": 0,
  "size": "string",
  "status": "READY",
  "storage_pool": {
    "block_group_factor": 1024,
    "block_size": 4194304,
    "filesystem": "string",
    "id": 0,
    "layout_map": "CLUSTER_BLOCKALLOCATIONTYPE",
    "max_disk_size": "string",
    "name": "string",
    "performance_pool": "no",
    "pool_usage": "DATA_AND_METADATA",
    "write_affinity": "YES",
    "write_affinity_depth": 0
  },
  "thin_disk": "THIN_DISK_NO",
  "uid": "string"
}

Examples

The following example gets details of the nsd_fvt_kuc_914 disk in the fs_no_replica_2 file system:

Request data:
curl -X 'GET' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs_no_replica_2/disks/nsd_fvt_kuc_914' \
  -H 'accept: application/json' \
  -n -k
Response data: 
{
    "name": "nsd_fvt_kuc_914",
    "filesystem": "fs_no_replica_2",
    "failure_group": "100",
    "remarks": "desc",
    "thin_disk": "THIN_DISK_NO",
    "driver_type": "nsd",
    "sector_size": 512,
    "metadata": true,
    "status": "READY",
    "availability": "UP",
    "id": 1,
    "disk_usage": "METADATA_ONLY",
    "storage_pool": {
        "name": "system"
    },
    "desc_replica": true,
    "size": "4398046511104",
    "uid": "8F021C0A:67EB086A"
}