Shares
List all shares.
get/v1/shares
Query parameters
limitinteger
Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
offsetinteger
Used in conjunction with limit to return a slice of items. offset is where to start in the list.
sortstring
Example:sort=name:desc,id:asc
Comma-separated list of sort keys and optional sort directions in the form of key:val
namestring
The share name
idstring
Database ID created for a share.
native_share_idstring
Actual ID of the share in the storage backend.
native_filesystem_idstring
Filesystem ID of the share in the storage backend.
native_qtree_idstring
Qtree ID of the share in the storage backend.
storage_idstring
Database ID created for a storage backend.
protocol'cifs' | 'nfs' | 'ftp' | 'hdfs'
The share protocol
Response
List share query was success
Example response
{
"shares": [
{
"id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
"created_at": "2017-07-10T14:36:58.014Z",
"updated_at": "2017-07-10T14:36:58.014Z",
"storage_id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
"native_share_id": "Share_A",
"native_filesystem_id": "Filesystem_A"
}
]
}