Filesystems/{filesystemName}/acl/{path}: GET

Gets information about the access control list (ACL) set for a file or directory.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET filesystems/filesystemName/acl/path request gets information about ACLs set for files or directories within a particular file system. For more information about the fields in the data structures that are returned, see the topics mmgetacl command and mmputacl command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/FileSystemName/acl/path

where

filesystems/filesystemName: The file system to which the file or directory belongs. Required.
acl/path: The path of the file or directory about which you want to get the ACL information. Required.

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
filesystemName	Name of the file system.	Required.
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
path	The file path relative to file system's mount point. The path of the file or directory is specified with forward slashes (/). For example: mnt/gpfs0/rest01. The forward slashes in the path are encoded to "%2F" in the request URL.	Required.

Request data

No request data.

Response data

{ 
  "status": {
      "code":"ReturnCode,
      "message":"ReturnMessage"
   },
   acl: 
      { 
         "type":"{NFSv4} ",
         "entries": [
                "type":"{allow | deny | alarm | audit }",
                "who":"User or group",
                "permissions":"Access permissions",
                "flags":"fFags",
          ],
   
}

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.

"acl":

An array of elements that describe ACL.

"type":"NFSv4"

Type of the ACL.

"entries":"Access control entries"

"type":"allow | deny | alarm | audit": Type of the entry.
"who":" special:owner@ | special:group@ | special:everyone@ | user:{name} | group:{name}": The name of the user or group of users for which the ACL is applicable.
"permission":"(r) read | (w) write | (m) mkdir, | (x) execute | (d) delete | (D) delete child | (a) read attr | (A) write attr (n) read named | (N) write Named | (c) read acl | (C) write acl | (o) change owner| (s) synchronize ": The access permissions.
"flags":"(f) file inherit | (d) dir inherit | (i) inherit only | (I) inherited | (S) successful access | (F) failed access": Special flags and inheritance definition.

Examples

The following example gets ACL information for the file system gpfs0 and path /rest_fset.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/gpfs0/acl/%2Frest_fset'

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": "..."
  },
  "acl": {
    "type": "NFSv4",
    "entries": [
      {
        "type": "allow",
        "who": "user:testuser",
        "permissions": "rxancs",
        "flags": "fd"
      }
    ]
  }
}