Resource URL: /platform/<<version=2>>/protocols/nfs/aliases

    Overview: This resource applies the standard collection pattern to NFS
              aliases.

     Methods: GET, POST

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

Method GET: List all NFS aliases.

       URL: GET /platform/<<version=2>>/protocols/nfs/aliases

Query arguments:
  sort=<string> The field that will be used for sorting.
  zone=<string> Access zone
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).
limit=<integer> Return no more than this many results at once (see resume).
check=<boolean> Check for conflicts when listing exports.
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }, 
    "aliases": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", 
        "properties": {
          "path": {
            "type": "string", 
            "description": "Specifies the path to which the alias points."
          }, 
          "health": {
            "type": [
              {
                "enum": [
                  "good", 
                  "illegal file type", 
                  "illegal path", 
                  "name conflict", 
                  "not exported", 
                  "path not found", 
                  "unknown"
                ], 
                "type": "string", 
                "description": "Specifies whether the alias is usable."
              }
            ], 
            "description": "Specifies whether the alias is usable."
          }, 
          "id": {
            "type": "string", 
            "description": "Specifies a string which represents the unique location of the alias."
          }, 
          "zone": {
            "type": "string", 
            "description": "Specifies the zone in which the alias is valid."
          }, 
          "name": {
            "type": "string", 
            "description": "Specifies the name by which the alias can be referenced."
          }
        }
      }, 
      "type": "array"
    }
  }
}

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

Method POST: Create a new NFS alias.

        URL: POST /platform/<<version=2>>/protocols/nfs/aliases

Query arguments:
zone=<string> Access zone

Required POST request body fields:
path, name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", 
  "properties": {
    "path": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the path to which the alias points."
    }, 
    "health": {
      "type": [
        {
          "enum": [
            "good", 
            "illegal file type", 
            "illegal path", 
            "name conflict", 
            "not exported", 
            "path not found", 
            "unknown"
          ], 
          "type": "string", 
          "description": "Specifies whether the alias is usable."
        }
      ], 
      "description": "Specifies whether the alias is usable."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the name by which the alias can be referenced."
    }, 
    "zone": {
      "type": "string", 
      "description": "Specifies the zone in which the alias is valid."
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "description": "Specifies the return value when an alias is successfully created or modified.", 
  "properties": {
    "health": {
      "required": true, 
      "type": [
        {
          "enum": [
            "good", 
            "illegal file type", 
            "illegal path", 
            "name conflict", 
            "not exported", 
            "path not found", 
            "unknown"
          ], 
          "type": "string", 
          "description": "Specifies whether the alias is usable."
        }
      ], 
      "description": "Specifies whether the alias is usable."
    }, 
    "id": {
      "required": true, 
      "type": "string", 
      "description": "Specifies a string which represents the unique location of the alias."
    }
  }
}
