v1

latestOpenAPI 3.0.0Apache 2.02026-07-176940115.5 KB
File Shares

Lists information for all file shares.

get/v1beta/{tenantId}/file/shares

Query parameters

limitinteger

Number of query results on multiple pages

offsetinteger

Start position of the pagination query

sortDir'asc' | 'desc'

Ascending or descending

sortKeystring

Sorting key word

namestring

The fileshare name

profileIdstring

The UUID of profile

statusstring

The fileshare status

Response

OK

idstring
createdAtstring date-time
updatedAtstring date-time
tenantIdstring
userIdstring
namestring
descriptionstring
sizeinteger
availabilityZonestring
statusstring
profileIdstring
protocolsstring[]
exportLocationsstring[]
metadataobject

Example response

[
  {
    "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
    "createdAt": "2017-07-10T14:36:58.014Z",
    "updatedAt": "2017-07-10T14:36:58.014Z",
    "size": 2,
    "metadata": {
      "lvPath": "string",
      "nfsFileshareID": "string",
      "nfsFileshareName": "string"
    }
  }
]