SOsodafoundation
File Shares

GET /v1beta/{tenantId}/file/shares

Changed on

Lists information for all file shares.

Request

  • Base URL
    https://localhost:50040
  • Auth
    HTTP basic

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"
    }
  }
]

Changes

  • 6f907ee4cf9bRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the // response property's maxLength was unset from 255 for the response status

    • breaking

      the // response property's minLength was decreased from 1 to 0 for the response status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter profileId

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter sortKey

    • info

      added the new optional query request parameter status

    • info

      added the optional property // to the response with the status

    • info

      the // response's property pattern [A-Za-z0-9_-] was removed for the status

  • 1c79c9d92d7bRevision changes
    • info

      the // response's property pattern [A-Za-z0-9_-] was added for the status