DeleteGatewayFileShares - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Operation description

Description

Warning

Deleting a file share interrupts services and data synchronization. Use this operation with caution.
Before you delete a Network File System (NFS) share, unmount it from the client. If you delete the share or the gateway before you unmount it, the mount target cannot be unmounted. Subsequent operations on the mount directory will freeze or become unresponsive.
Deleting a file share does not stop billing for the gateway. If you no longer need the gateway, call the DeleteGateway operation to delete the gateway and avoid further charges.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DeleteGatewayFileShares

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbv****
IndexId	string	Yes	The ID of the file share. You can call the DescribeGatewayFileShares operation to query the IDs of file shares.	NFSalex***
Force	boolean	No	Specifies whether to force delete the file share. Valid values: true: Force deletes the file share even if data synchronization is incomplete. Use this option with caution. false (default): Does not delete the file share if data synchronization is incomplete.	false

Response elements

Element	Type	Description	Example
	object
TaskId	string	The ID of the task.	t-000c6hshwukkcfn****
Message	string	The message that is returned.	successful
RequestId	string	The ID of the request.	t-000czaedx5koz578vk**
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

{
  "TaskId": "t-000c6hshwukkcfn****",
  "Message": "successful",
  "RequestId": "t-000czaedx5koz578vk**",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyShareIndexId	You must enter a valid file sharing ID.	You must enter a valid file sharing ID.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. Try again later.
500	InternalError	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.