调用UpdateGatewayFileShare接口在文件网关下更新一个文件共享配置。

调用该接口时，您需要注意：

  • 您已经创建部署完成文件网关，并已经完成一个文件共享的配置。
  • 该更新接口会更新文件共享对应的所有暴露参数，如果您不想更新某个参数，请调用时务必传入该参数原值，否则该文件共享参数会被设置成默认值。

调试

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

请求参数

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

系统规定参数。取值为UpdateGatewayFileShare。
GatewayId String 是 gw-000c6hshwukkbryp****

网关ID。
IndexId String 是 NFStest

文件共享ID。可以通过DescribeGatewayFileShares接口获得。
Name String 是 name

文件共享名称。可以通过DescribeGatewayFileShares接口获得。不支持修改。
RemoteSync Boolean 否 true

文件共享是否打开反向同步。取值范围如下：

  • false（默认）：否。
  • true：是。
RemoteSyncDownload Boolean 否 false

复制模式情况下，是否下载文件数据。网关版本1.2.0及以上支持此参数。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 只有当该共享打开了反向同步或者加入极速同步组时候，这个参数才生效。
PollingInterval Integer 否 36000

文件共享反向同步时间间隔。单位秒，在启用反向同步情况下必传。取值范围为15~36000。

说明 在复制模式和反向同步启用下载文件数据时，取值范围为3600~36000。
IgnoreDelete Boolean 否 true

文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 网关版本1.0.40及以上支持此参数。
FrontendLimit Integer 否 0

文件共享最大写入速度，单位为MB/s。取值范围为0~1280，0为默认值，表示无限制。
BackendLimit Integer 否 0

文件共享最大上传速度，单位为MB/s。0代表无限制。取值范围为0~1280，0为默认值，表示无限制。

说明 如果同时已限制最大写入速度，最大上传速度不能小于最大写入速度。
DownloadLimit Integer 否 0

文件共享最大下载速度，单位为MB/s。取值范围为0~12800，0表示无限制，只在复制模式且开启下载文件数据时才可设置。网关版本1.3.0及以上支持此参数。

说明 只有当该共享打开了反向同步或者加入极速同步组时，此参数才生效。
InPlace Boolean 否 false

文件共享是否碎片优化。取值范围如下：

  • false（默认）：否。
  • true：是。
CacheMode String 否 Cache

文件共享缓存模式。可以通过DescribeGatewayFileShares接口获得。不支持修改。
Browsable Boolean 否 false

文件共享SMB协议下是否可浏览（即网络邻居中是否可发现）。该参数在NFS协议下无效。取值范围如下：

  • true（默认）：是。
  • false：否。
Squash String 否 none

文件共享NFS协议下用户映射。取值范围如下：

  • none。
  • root_squash。
  • all_squash。
  • all_anonymous。

默认值为none。
ReadWriteUserList String 否 user1,user2

文件共享SMB协议下读写用户列表。多个用户使用“,”分隔。

说明 该参数在NFS协议下无效。
ReadOnlyUserList String 否 user1,user2

文件共享SMB协议下只读用户列表。多个用户使用“,”分隔。

说明 该参数在NFS协议下无效。
ReadWriteClientList String 否 172.16.146.100

文件共享NFS协议下读写客户端列表（可以是IP地址或者IP地址范围)。多个客户端使用“,”分隔。
ReadOnlyClientList String 否 172.16.146.100

文件共享NFS协议下只读客户端列表（可以是IP地址或者IP地址范围）。多个客户端使用“,”分隔。
LagPeriod Long 否 5

同步延迟，即网关本地缓存同步到云上OSS的延迟时间。单位为秒。取值范围为5~120，5为默认值。

说明 网关版本1.0.40及以上支持此参数。
DirectIO Boolean 否 false

文件共享是否启用DirectIO（直接I/O方式进行数据传输）。取值范围如下：

  • false（默认）：否。
  • true：是。
ServerSideEncryption Boolean 否 false

文件共享是否启用服务端加密。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 需要联系我们开启白名单后才可进行相关设置，同时服务端加密和客户端加密不可同时配置。
ServerSideCmk String 否 b1e08822-1e9c-4f8e-9dd1-a740cb200***

文件共享启用服务端加密情况下，加密所使用的KMS key。

说明 KMS key必须是和网关处于相同Region下。
ClientSideEncryption Boolean 否 false

文件共享是否启用客户端加密。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 需要联系我们开启白名单后才可进行相关设置，且只支持增强型以上的线上网关，同时服务端加密和客户端加密不可同时配置。
ClientSideCmk String 否 b1e08822-1e9c-4f8e-9dd1-a740cb200***

文件共享启用客户端加密情况下，加密所使用的KMS key。

说明 KMS key必须是和网关处于相同region下。
KmsRotatePeriod Long 否 0

文件共享启用客户端加密情况下，密钥轮转时间周期。单位为秒。轮转的取值范围为3600~360×86400，0为默认值，表示不轮转。
FastReclaim Boolean 否 true

文件共享是否开启上传优化，适合数据纯备份上云场景。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 网关版本1.0.39及以上支持此参数。
WindowsAcl Boolean 否 false

文件共享SMB协议下，是否开启通过Windows访问列表（需要AD域）进行权限控制。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 网关版本1.0.45及以上支持此参数。
AccessBasedEnumeration Boolean 否 false

文件共享SMB协议下，是否启用Windows ABE。需要windowsAcl参数设置为true情况下生效。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 网关版本1.0.45及以上支持此参数。
NfsV4Optimization Boolean 否 true

文件共享NFS协议下，是否启用NFS v4优化，提升挂载上传效率。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 开启后将不支持NFS v3形式挂载，网关版本1.2.0及以上支持此参数。
TransferAcceleration Boolean 否 false

文件共享是否开启传输加速功能，需要对应OSS Bucket已开启传输加速。

说明 网关版本1.3.0及以上支持此参数。
BypassCacheRead Boolean 否 false

文件共享是否启用直读OSS功能，不通过网关缓存直接读OSS数据。取值范围如下：

  • false（默认）：否。
  • true：是。
说明 不建议开启此功能。

返回数据

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

任务ID。
Message String successful

请求结果描述。
RequestId String EBAF769F-2E88-4D81-AF1E-A34FAACF9***

请求ID。
Code String 200

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

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateGatewayFileShare
&GatewayId=gw-000c6hshwukkbrypj***
&IndexId=NFStest
&Name=name
&<公共请求参数>

正常返回示例

XML格式 

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

<UpdateGatewayFileShareResponse>
    <TaskId>t-000avsri6tlyddgf****</TaskId>
    <Message>successful</Message>
    <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</UpdateGatewayFileShareResponse>

JSON格式 

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

{
  "TaskId" : "t-000avsri6tlyddgf****",
  "Message" : "successful",
  "RequestId" : "EBAF769F-2E88-4D81-AF1E-A34FAACF9***",
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter.FileShare.%s The specified field %s for file share is invalid. Please check it again. 网关文件共享参数非法，请检查。
400 VersionNotSupported.FileShare.%s The specified field %s for file share is not supported by current gateway version. Please check it again. 网关文件共享参数于当前网关版本不支持，请检查。

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