Filesystems/{filesystemName}/policies: GET

Gets the details of the information lifecycle management (ILM) policies applicable to a specific file system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystemName}/policies request gets the details of the ILM policies applicable to a specific file system. For more information about the fields in the data structures that are returned, see mmapplypolicy command and mmlspolicy command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/{filesystemName}/policies
where
filesystems/{filesystemName}/policies
Specifies that the GET request fetches the policies that are applicable to a specific file system.

Request headers

Content-Type: application/json
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
filesystemName The file system name. You can also use keywords such as :all:, :all_local:, or :all_remote: Required.
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.

Request data

No request data.

Response data

The following list of attributes are available in the response data:

{      
"status":
   {
      "code": ReturnCode
      "message": "ReturnMessage",   
   },
"paging":
   {
      "next": Next page URL
      "fields": "Fields",  
      "filter": Filter
      "baseUrl": "URL", 
      "lastID": ID
      ,  
   },
{
   "policies": [
      {
         "filesystemName": "File system name"
         "policy": "Policy settings"
       }
}
"status":
Return status.
"code": ReturnCode,
The HTTP status code that was returned by the request.
"message": "ReturnMessage"
The return message.
"paging":
An array of information about the paging information that is used for displaying the details.
"next": "Next page URL"
The URL to retrieve the next page. Paging is enabled when more than 1000 objects would be returned by the query.
"fields": "Fields in the request"
The fields that are used in the original request.
"filter": "Filters used in the request"
The filter that is used in the original request.
"baseUrl": "URL"
The URL of the request without any parameters.
"lastId": "ID"
The ID of the last element that can be used to retrieve the next elements.
"policies":
An array of information about the ILM policies applicable to a file system.
"filesystemName": "File system name"
The file system for which the ILM policies are applicable.
"policy": "Policy settings"
Details of the ILM policy applicable to the specified file system.

The return information and the information that the command retrieves are returned in the same way as they are for the other requests. The parameters that are returned are the same as the configuration attributes that are displayed by the mmaplypolicy command. For more information, see mmlspolicy command and mmapplypolicy command.

Examples

The following example gets information about the cluster configuration.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/gpfs0/policies'
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.
The policies array provides information about the ILM policies applicable to the file system gpfs0. 
{
  "status": {
    "code": 200,
    "message": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/filesystems/gpfs0/filesets?lastId=10001",
    "fields": "period,restrict,sensorName",
    "filter": "usedInodes>100,maxInodes>1024",
    "baseUrl": "/scalemgmt/v2/perfmon/sensor/config",
    "lastId": 10001
  },
  "policies": [
    {
      "filesystemName": "gpfs0",
      "policy": "RULE 'placement' SET POOL 'system'"
    }
  ]
}