文档

DeleteGatewayFileShares

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

调用DeleteGatewayFileShares接口删除云存储网关上的文件共享。

接口说明

警告 删除共享会导致您的业务和数据同步中断,请谨慎操作。

请求参数

名称 类型 是否必选 示例值 描述
Action String DeleteGatewayFileShares

系统规定参数。取值为DeleteGatewayFileShares。

GatewayId String gw-000eg44nmxbsfwbv****

网关ID。

IndexId String NFSalex***

文件共享在网关内部的ID。可以通过DescribeGatewayFileShares接口获得。

Force Boolean false

是否强制删除。可能值:

  • true:强制删除同步未完成的文件共享,请谨慎操作。
  • false(默认):不删除同步未完成的文件共享。

返回数据

名称 类型 示例值 描述
TaskId String t-000c6hshwukkcfn****

任务ID。

Message String successful

请求结果描述。

RequestId String t-000czaedx5koz578vk**

请求ID。

Code String 200

状态码。状态码为200表示请求成功。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteGatewayFileShares
&GatewayId=gw-000eg44nmxbsfwbvq2**
&IndexId=NFSalex***
&<公共请求参数>

正常返回示例

XML格式

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格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "t-000c6hshwukkcfn****",
  "Message" : "successful",
  "RequestId" : "D3205DCC-D32B-497D-BB49-E212C608AD**",
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 EmptyShareIndexId You must enter a valid file sharing ID. 文件共享ID不能为空,请输入一个有效值。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在,请确认输入参数是否正确。
400 GatewayInOperation The gateway is processing requests. Try again later. 网关正在进行操作中,请稍后再试。
500 InternalError Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket. 内部错误,请重试。如果多次尝试失败,请提交工单。

访问错误中心查看更多错误码。