Resource URL: /platform/<<version=3>>/storagepool/storagepools

    Overview: This resource applies the standard collection pattern to OneFS
              storage pools. These can be either tiers, or node pools,
              optionally filtering out node pools contained within tiers if the
              'toplevels' argument is supplied.

     Methods: GET

********************************************************************************

Method GET: List all storage pools.

       URL: GET /platform/<<version=3>>/storagepool/storagepools

Query arguments:
     sort=<string> The field that will be used for sorting.
toplevels=<string> If true, node pools contained within tiers will be filtered
                   out of results.
        dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "storagepools": {
          "minItems": 0, 
          "items": {
            "health_flags": {
              "items": {
                "enum": [
                  "underprovisioned", 
                  "missing_drives", 
                  "devices_down", 
                  "devices_smartfailed", 
                  "waiting_repair"
                ], 
                "type": "string"
              }, 
              "type": "array", 
              "description": "An array of containing any health issues with this pool.  If the pool is healthy, the list is empty.  Only appears on 'nodepool' type storagepools."
            }, 
            "type": "object", 
            "properties": {
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The pool name."
              }, 
              "lnns": {
                "items": {
                  "type": "integer"
                }, 
                "required": true, 
                "type": "array", 
                "description": "The nodes that are part of this pool."
              }, 
              "l3_status": {
                "enum": [
                  "l3", 
                  "storage", 
                  "migrating"
                ], 
                "type": "string", 
                "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", 
                "required": false
              }, 
              "can_enable_l3": {
                "required": false, 
                "type": "boolean", 
                "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives."
              }, 
              "manual": {
                "required": false, 
                "type": "boolean", 
                "description": "Whether or not the node pool is manually managed."
              }, 
              "children": {
                "items": {
                  "type": [
                    "string", 
                    "integer"
                  ]
                }, 
                "required": false, 
                "type": "array", 
                "description": "The names or IDs of the pool's children."
              }, 
              "protection_policy": {
                "required": false, 
                "type": "string", 
                "description": "The underlying protection policy."
              }, 
              "l3": {
                "required": false, 
                "type": "boolean", 
                "description": "Use SSDs in this node pool for L3 cache."
              }, 
              "can_disable_l3": {
                "required": false, 
                "type": "boolean", 
                "description": "Indicates if disabling L3 is possible."
              }, 
              "usage": {
                "required": true, 
                "type": "object", 
                "description": "Total pool usage.", 
                "properties": {
                  "used_hdd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Used bytes in the pool on HDD drives."
                  }, 
                  "avail_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Available free bytes remaining in the pool when virtual hot spare is taken into account."
                  }, 
                  "usable_ssd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool on SSD drives when virtual hot spare is taken into account."
                  }, 
                  "pct_used_hdd": {
                    "required": true, 
                    "type": "string", 
                    "description": "Percentage of usable space on HDD drives in the pool which is used."
                  }, 
                  "avail_hdd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Available free bytes remaining in the pool on HDD drives when virtual hot spare is taken into account."
                  }, 
                  "pct_used_ssd": {
                    "required": true, 
                    "type": "string", 
                    "description": "Percentage of usable space on SSD drives in the pool which is used."
                  }, 
                  "avail_ssd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Available free bytes remaining in the pool on SSD drives when virtual hot spare is taken into account."
                  }, 
                  "free_hdd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Free bytes remaining in the pool on HDD drives."
                  }, 
                  "virtual_hot_spare_bytes": {
                    "required": false, 
                    "type": "string"
                  }, 
                  "free_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Free bytes remaining in the pool."
                  }, 
                  "total_ssd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool on SSD drives."
                  }, 
                  "total_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool."
                  }, 
                  "pct_used": {
                    "required": true, 
                    "type": "string", 
                    "description": "Percentage of usable space in the pool which is used."
                  }, 
                  "balanced": {
                    "required": true, 
                    "type": "boolean", 
                    "description": "Whether or not the pool usage is currently balanced."
                  }, 
                  "used_bytes": {
                    "required": false, 
                    "type": "string", 
                    "description": "Used bytes in the pool."
                  }, 
                  "free_ssd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Free bytes remaining in the pool on SSD drives."
                  }, 
                  "usable_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool drives when virtual hot spare is taken into account."
                  }, 
                  "usable_hdd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool on HDD drives when virtual hot spare is taken into account."
                  }, 
                  "used_ssd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Used bytes in the pool on SSD drives."
                  }, 
                  "total_hdd_bytes": {
                    "required": true, 
                    "type": "string", 
                    "description": "Total bytes in the pool on HDD drives."
                  }
                }
              }, 
              "type": {
                "enum": [
                  "tier", 
                  "nodepool"
                ], 
                "type": "string", 
                "description": "The pool type.", 
                "required": true
              }, 
              "id": {
                "required": true, 
                "type": "integer", 
                "description": "The system ID given to the pool."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }
      }
    }
  ]
}
