Endpoint

/v1/files/{ref}/locks/smb/share-mode/

GET

Return a list of all SMB share mode locks currently granted on the specified file.

Parameters

Name Description Required
ref The file ID or the absolute path to the file system object. File IDs can be found in the id field of responses of APIs that return file attributes. You must URL-encode the paths. The APIs & Tools page in the Qumulo Core Web UI URL-encodes the paths. Yes
snapshot The snapshot ID that specifies the version of the filesystem to use. If not specified, use the head version. No
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_share_mode_grants",
  "type": "object",
  "properties": {
    "grants": {
      "type": "array",
      "items": {
        "description": "grants",
        "type": "object",
        "properties": {
          "file_id": {
            "description": "file_id",
            "type": "string"
          },
          "stream_id": {
            "description": "stream_id",
            "type": "string"
          },
          "snapshot_id": {
            "description": "The locked file's snapshot ID. Empty if the file is at the head version (not from a snapshot).",
            "type": "string"
          },
          "mode": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "API_SHARE_MODE_READ",
                "API_SHARE_MODE_WRITE",
                "API_SHARE_MODE_DELETE",
                "API_SHARE_MODE_EXCLUDE_READ",
                "API_SHARE_MODE_EXCLUDE_WRITE",
                "API_SHARE_MODE_EXCLUDE_DELETE"
              ],
              "description": "mode:\n * `API_SHARE_MODE_DELETE` - API_SHARE_MODE_DELETE,\n * `API_SHARE_MODE_EXCLUDE_DELETE` - API_SHARE_MODE_EXCLUDE_DELETE,\n * `API_SHARE_MODE_EXCLUDE_READ` - API_SHARE_MODE_EXCLUDE_READ,\n * `API_SHARE_MODE_EXCLUDE_WRITE` - API_SHARE_MODE_EXCLUDE_WRITE,\n * `API_SHARE_MODE_READ` - API_SHARE_MODE_READ,\n * `API_SHARE_MODE_WRITE` - API_SHARE_MODE_WRITE"
            }
          },
          "owner_id": {
            "description": "The unique identifier for the process that owns the file lock.",
            "type": "string"
          },
          "owner_address": {
            "description": "The IP address to use for acquiring the file lock.",
            "type": "string"
          },
          "node_address": {
            "description": "The IP address of the node that receives the request.",
            "type": "string"
          }
        }
      }
    }
  }
}