SharesApi
All URIs are relative to https://nfs.de-fra.ionos.com
Method | HTTP request | Description |
---|---|---|
Delete /clusters/{clusterId}/shares/{shareId} | Delete Share | |
Get /clusters/{clusterId}/shares/{shareId} | Retrieve Share | |
Get /clusters/{clusterId}/shares | Retrieve Shares | |
Post /clusters/{clusterId}/shares | Create Share | |
Put /clusters/{clusterId}/shares/{shareId} | Ensure Share |
ClustersSharesDelete
Delete Share
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
clusterId | string | The identifier (UUID) of the cluster. | |
shareId | string | The identifier (UUID) of the share. |
Other Parameters
Other parameters are passed through a pointer to an apiClustersSharesDeleteRequest struct via the builder pattern
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
. An operation is uniquely identified by "SharesApiService.ClustersSharesDelete"
string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ClustersSharesFindById
Retrieve Share
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
clusterId | string | The identifier (UUID) of the cluster. | |
shareId | string | The share identifier. |
Other Parameters
Other parameters are passed through a pointer to an apiClustersSharesFindByIdRequest struct via the builder pattern
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
. An operation is uniquely identified by "SharesApiService.ClustersSharesFindById"
string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ClustersSharesGet
Retrieve Shares
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
clusterId | string | The identifier (UUID) of the cluster. |
Other Parameters
Other parameters are passed through a pointer to an apiClustersSharesGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
offset | int32 | The first element from the total list of elements to include in the response. Use this parameter together with the limit for pagination. | [default to 0] |
limit | int32 | The maximum number of elements to return. Use this parameter together with the offset for pagination. | [default to 100] |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
. An operation is uniquely identified by "SharesApiService.ClustersSharesGet"
string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ClustersSharesPost
Create Share
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
clusterId | string | The identifier (UUID) of the cluster. |
Other Parameters
Other parameters are passed through a pointer to an apiClustersSharesPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
shareCreate | Share to create. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
. An operation is uniquely identified by "SharesApiService.ClustersSharesPost"
string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ClustersSharesPut
Ensure Share
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
clusterId | string | The identifier (UUID) of the cluster. | |
shareId | string | The identifier (UUID) of the share. |
Other Parameters
Other parameters are passed through a pointer to an apiClustersSharesPutRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
shareEnsure | Update Share |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
. An operation is uniquely identified by "SharesApiService.ClustersSharesPut"
string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
Last updated