Deletes a share from a gateway.
Usage notes
Warning Deleting shares will interrupt your business activities and data synchronization tasks. Exercise caution when performing this action.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DeleteGatewayFileShares | The operation that you want to perform. Set the value to DeleteGatewayFileShares. |
GatewayId | String | Yes | gw-000eg44nmxbsfwbv**** | The ID of the gateway. |
IndexId | String | Yes | NFSalex*** | The ID of the share. You can query the share ID by calling the DescribeGatewayFileShares operation. |
Force | Boolean | No. | false | Specifies whether to forcibly delete the share if data synchronization is not complete. Default value: false. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TaskId | String | t-000c6hshwukkcfn**** | The ID of the task. |
Message | String | successful | The description of the request result. |
RequestId | String | t-000czaedx5koz578vk** | The ID of the request. |
Code | String | 200 | The HTTP status code returned. A value of 200 indicates that the request was successful. |
Success | Boolean | true | Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DeleteGatewayFileShares
&GatewayId=gw-000eg44nmxbsfwbvq2**
&IndexId=NFSalex***
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DeleteGatewayFileSharesResponse>
<TaskId>t-000c6hshwukkcfn****</TaskId>
<Message>successful</Message>
<RequestId>D3205DCC-D32B-497D-BB49-E212C608AD**</RequestId>
<Code>200</Code>
<Success>true</Success>
</DeleteGatewayFileSharesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"TaskId" : "t-000c6hshwukkcfn****",
"Message" : "successful",
"RequestId" : "D3205DCC-D32B-497D-BB49-E212C608AD**",
"Code" : 200,
"Success" : true
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | EmptyShareIndexId | You must enter a valid file sharing ID. | The error message returned because the ID of the share is not specified. Set the share ID to a valid value. |
400 | GatewayNotExist | The specified gateway does not exist. You must specify a valid parameter. | The error message returned because the specified gateway does not exist. Check whether the parameters are valid. |
400 | GatewayInOperation | The gateway is processing requests . Try again later. | The error message returned because another operation is in progress. Try again later. |
500 | InternalError | Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket. | The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket. |
For a list of error codes, see Service error codes.