Retrieve Shares You can retrieve the list of all shares from within a cluster using its clusterId. The number of results displayed on each page depends on the following values:
limit limits the number of response elements.
offset specifies the starting point within the collection of resource results returned from the server.
Endpoint
Use the regional endpoints to retrieve all shares:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares
Request
Note: The following request contains sample values. Remember to replace them with the relevant information.
Copy curl -X 'GET' \
'https: //nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares?offset=0&limit=100' \
-H 'accept: application/json' Path Parameters
Below is the list of mandatory path parameter:
Body Parameters
Type
Description
Example
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Response
A 200 message confirms that all shares from within the specific cluster are successfully retrieved.
Copy {
"id" : "ce834630-97f2-56a7-bc99-4427e61d4714" ,
"type" : "collection" ,
"href" : "/clusters/{clusterId}/shares" ,
"items" : [
{
"id" : "7b1ef56d-dfc6-51fe-aff0-7af2d6747868" ,
"type" : "share" ,
"href" : "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868" ,
"metadata" : {
"createdDate" : "2020-12-10T13:37:50+01:00" ,
"createdBy" : "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3" ,
"createdByUserId" : "87f9a82e-b28d-49ed-9d04-fba2c0459cd3" ,
"lastModifiedDate" : "2020-12-11T13:37:50+01:00" ,
"lastModifiedBy" : "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3" ,
"lastModifiedByUserId" : "87f9a82e-b28d-49ed-9d04-fba2c0459cd3" ,
"resourceURN" : "ionos:<product>:<location>:<contract>:<resource-path>" ,
"status" : "AVAILABLE" ,
"statusMessage" : null ,
"nfsPath" : "/data/example-export"
} ,
"properties" : {
"name" : "example-export" ,
"quota" : 512 ,
"clientGroups" : [
{
"ipNetworks" : [
"10.234.50.0/24"
] ,
"hosts" : [
"10.234.62.123"
] ,
"nfs" : {
"squash" : "all-anonymous"
}
}
]
}
}
] ,
"offset" : 0 ,
"limit" : 42 ,
"_links" : {
"prev" : "http://PREVIOUS-PAGE-URI" ,
"self" : "http://THIS-PAGE-URI" ,
"next" : "http://NEXT-PAGE-URI"
}
} ```