DeleteGatewayFileShares - 删除文件共享

重要

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

删除指定文件网关中的指定文件共享。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hcs-sgw:DeleteGatewayFileSharesdelete
*全部资源
*

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

gw-000eg44nmxbsfwbv****
IndexIdstring

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

NFSalex***
Forceboolean

是否强制删除。可能值:

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

  • false(默认):不删除同步未完成的文件共享。

false

返回参数

名称类型描述示例值
object
TaskIdstring

任务 ID。

t-000c6hshwukkcfn****
Messagestring

请求结果描述。

successful
RequestIdstring

请求 ID。

t-000czaedx5koz578vk**
Codestring

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

200
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史