UpdateGatewayFileShare - 更新文件共享配置_云存储网关(CSG)-阿里云帮助中心

在文件网关下更新文件共享配置。

接口说明

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

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:UpdateGatewayFileShare

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000c6hshwukkbryp****
IndexId	string	是	文件共享 ID。可以通过 DescribeGatewayFileShares 接口获得。	NFStest
Name	string	是	文件共享名称。可以通过 DescribeGatewayFileShares 接口获得。不支持修改。	name
RemoteSync	boolean	否	文件共享是否打开反向同步。取值范围如下： false（默认）：否。 true：是。	true
RemoteSyncDownload	boolean	否	复制模式情况下，是否下载文件数据。网关版本 1.2.0 及以上支持此参数。取值范围如下： false（默认）：否。 true：是。说明只有当该共享打开了反向同步或者加入极速同步组时候，这个参数才生效。	false
PollingInterval	integer	否	文件共享反向同步时间间隔。单位秒，在启用反向同步情况下必传。取值范围为 15~36000。说明在复制模式和反向同步启用下载文件数据时，取值范围为 3600~36000。	36000
IgnoreDelete	boolean	否	文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。取值范围如下： false（默认）：否。 true：是。说明网关版本 1.0.40 及以上支持此参数。	true
FrontendLimit	integer	否	文件共享最大写入速度，单位为 MB/s。取值范围为 0~1280，0 为默认值，表示无限制。	0
BackendLimit	integer	否	文件共享最大上传速度，单位为 MB/s。0 代表无限制。取值范围为 0~1280，0 为默认值，表示无限制。说明如果同时已限制最大写入速度，最大上传速度不能小于最大写入速度。	0
DownloadLimit	integer	否	文件共享最大下载速度，单位为 MB/s。取值范围为 0~12800，0 表示无限制，只在复制模式且开启下载文件数据时才可设置。网关版本 1.3.0 及以上支持此参数。说明只有当该共享打开了反向同步或者加入极速同步组时，此参数才生效。	0
InPlace	boolean	否	已废弃，不建议设置。	false
CacheMode	string	否	文件共享缓存模式。可以通过 DescribeGatewayFileShares 接口获得。不支持修改。	Cache
Browsable	boolean	否	文件共享 SMB 协议下是否可浏览（即网络邻居中是否可发现）。取值范围如下： true（默认）：是。 false：否。说明该参数在 NFS 协议下无效。	false
Squash	string	否	文件共享 NFS 协议下用户映射，默认值为 none。取值范围如下： none。 root_squash。 all_squash。 all_anonymous。	none
ReadWriteUserList	string	否	文件共享 SMB 协议下读写用户列表。多个用户使用“,”分隔。说明该参数在 NFS 协议下无效。	user1,user2
ReadOnlyUserList	string	否	文件共享 SMB 协议下只读用户列表。多个用户使用“,”分隔。说明该参数在 NFS 协议下无效。	user1,user2
ReadWriteClientList	string	否	文件共享 NFS 协议下读写客户端列表（可以是 IP 地址或者 IP 地址范围)。多个客户端使用“,”分隔。	172.16.146.100
ReadOnlyClientList	string	否	文件共享 NFS 协议下只读客户端列表（可以是 IP 地址或者 IP 地址范围）。多个客户端使用“,”分隔。	172.16.146.100
LagPeriod	integer	否	同步延迟，即网关本地缓存同步到云上 OSS 的延迟时间。单位为秒。取值范围为 5~120，5 为默认值。说明网关版本 1.0.40 及以上支持此参数。	5
DirectIO	boolean	否	文件共享是否启用 DirectIO（直接 I/O 方式进行数据传输）。取值范围如下： false（默认）：否。 true：是。	false
ServerSideEncryption	boolean	否	文件共享是否启用服务端加密。取值范围如下： false（默认）：否。 true：是。说明需要联系我们开启白名单后才可进行相关设置。	false
ServerSideCmk	string	否	文件共享启用服务端加密情况下，加密所使用的 KMS key。说明 KMS key 必须是和网关处于相同 Region 下。	b1e08822-1e9c-4f8e-9dd1-a740cb200***
ClientSideEncryption	boolean	否	废弃。	false
ClientSideCmk	string	否	废弃。	b1e08822-1e9c-4f8e-9dd1-a740cb200***
KmsRotatePeriod	integer	否	废弃。	0
FastReclaim	boolean	否	文件共享是否开启上传优化，适合数据纯备份上云场景。取值范围如下： false（默认）：否。 true：是。说明网关版本 1.0.39 及以上支持此参数。	true
WindowsAcl	boolean	否	文件共享 SMB 协议下，是否开启通过 Windows 访问列表（需要 AD 域）进行权限控制。取值范围如下： false（默认）：否。 true：是。说明网关版本 1.0.45 及以上支持此参数。	false
AccessBasedEnumeration	boolean	否	文件共享 SMB 协议下，是否启用 Windows ABE。需要 windowsAcl 参数设置为 true 情况下生效。取值范围如下： false（默认）：否。 true：是。说明网关版本 1.0.45 及以上支持此参数。	false
NfsV4Optimization	boolean	否	文件共享 NFS 协议下，是否启用 NFS v4 优化，提升挂载上传效率。取值范围如下： false（默认）：否。 true：是。说明开启后将不支持 NFS v3 形式挂载，网关版本 1.2.0 及以上支持此参数。	true
TransferAcceleration	boolean	否	文件共享是否开启传输加速功能，需要对应 OSS Bucket 已开启传输加速。说明网关版本 1.3.0 及以上支持此参数。	false
BypassCacheRead	boolean	否	文件共享是否启用直读 OSS 功能，不通过网关缓存直接读 OSS 数据。取值范围如下： false（默认）：否。 true：是。说明不建议开启此功能。	false
ServerSideAlgorithm	string	否	加密算法。取值范围如下： AES256（默认）。 SM4。	AES256

返回参数

名称	类型	描述	示例值
	object
TaskId	string	任务 ID。	t-000avsri6tlyddgf****
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	EBAF769F-2E88-4D81-AF1E-A34FAACF9***
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.	网关文件共享参数于当前网关版本不支持，请检查。

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

变更历史

更多信息，参考变更详情。