接口说明
调用该接口时,您需要注意:
-
您已经创建部署完成文件网关,并已经完成一个文件共享的配置。
-
该更新接口会更新文件共享对应的所有暴露参数,如果您不想更新某个参数,请调用时务必传入该参数原值,否则该文件共享参数会被设置成默认值。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
GatewayIdstring | 网关 ID。 示例值:gw-000c6hshwukkbryp****参考取值来源: ModifyGateway CreateGateway DescribeGateways |
IndexIdstring | 文件共享 ID。可以通过 DescribeGatewayFileShares 接口获得。 示例值:NFStest |
Namestring | 文件共享名称。可以通过 DescribeGatewayFileShares 接口获得。不支持修改。 示例值:name |
RemoteSyncboolean | 文件共享是否打开反向同步。取值范围如下:展开详情 示例值:true |
RemoteSyncDownloadboolean | 复制模式情况下,是否下载文件数据。网关版本 1.2.0 及以上支持此参数。取值范围如下:展开详情 示例值:false |
PollingIntervalinteger<int32> | 文件共享反向同步时间间隔。单位秒,在启用反向同步情况下必传。取值范围为 15~36000。展开详情 示例值:36000 |
IgnoreDeleteboolean | 文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。取值范围如下:展开详情 示例值:true |
FrontendLimitinteger<int32> | 文件共享最大写入速度,单位为 MB/s。取值范围为 0~1280,0 为默认值,表示无限制。 示例值:0 |
BackendLimitinteger<int32> | 文件共享最大上传速度,单位为 MB/s。0 代表无限制。取值范围为 0~1280,0 为默认值,表示无限制。展开详情 示例值:0 |
DownloadLimitinteger<int32> | 文件共享最大下载速度,单位为 MB/s。取值范围为 0~12800,0 表示无限制,只在复制模式且开启下载文件数据时才可设置。网关版本 1.3.0 及以上支持此参数。展开详情 示例值:0 |
InPlaceboolean | 已废弃,不建议设置。 示例值:false |
CacheModestring | 文件共享缓存模式。可以通过 DescribeGatewayFileShares 接口获得。不支持修改。 示例值:Cache |
Browsableboolean | 文件共享 SMB 协议下是否可浏览(即网络邻居中是否可发现)。取值范围如下:展开详情 示例值:false |
Squashstring | 文件共享 NFS 协议下用户映射,默认值为 none。取值范围如下:展开详情 示例值:none |
ReadWriteUserListstring | 文件共享 SMB 协议下读写用户列表。多个用户使用“,”分隔。展开详情 示例值:user1,user2 |
ReadOnlyUserListstring | 文件共享 SMB 协议下只读用户列表。多个用户使用“,”分隔。展开详情 示例值:user1,user2 |
ReadWriteClientListstring | 文件共享 NFS 协议下读写客户端列表(可以是 IP 地址或者 IP 地址范围)。多个客户端使用“,”分隔。 示例值:172.16.146.100 |
ReadOnlyClientListstring | 文件共享 NFS 协议下只读客户端列表(可以是 IP 地址或者 IP 地址范围)。多个客户端使用“,”分隔。 示例值:172.16.146.100 |
LagPeriodinteger<int64> | 同步延迟,即网关本地缓存同步到云上 OSS 的延迟时间。单位为秒。取值范围为 5~120,5 为默认值。展开详情 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:5 |
DirectIOboolean | 文件共享是否启用 DirectIO(直接 I/O 方式进行数据传输)。取值范围如下:展开详情 示例值:false |
ServerSideEncryptionboolean | 文件共享是否启用服务端加密。取值范围如下:展开详情 示例值:false |
ServerSideCmkstring | 文件共享启用服务端加密情况下,加密所使用的 KMS key。展开详情 示例值:b1e08822-1e9c-4f8e-9dd1-a740cb200*** |
ClientSideEncryptionboolean | 废弃。 示例值:false |
ClientSideCmkstring | 废弃。 示例值:b1e08822-1e9c-4f8e-9dd1-a740cb200*** |
KmsRotatePeriodinteger<int64> | 废弃。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:0 |
FastReclaimboolean | 文件共享是否开启上传优化,适合数据纯备份上云场景。取值范围如下:展开详情 示例值:true |
WindowsAclboolean | 文件共享 SMB 协议下,是否开启通过 Windows 访问列表(需要 AD 域)进行权限控制。取值范围如下:展开详情 示例值:false |
AccessBasedEnumerationboolean | 文件共享 SMB 协议下,是否启用 Windows ABE。需要 windowsAcl 参数设置为 true 情况下生效。取值范围如下:展开详情 示例值:false |
NfsV4Optimizationboolean | 文件共享 NFS 协议下,是否启用 NFS v4 优化,提升挂载上传效率。取值范围如下:展开详情 示例值:true |
TransferAccelerationboolean | 文件共享是否开启传输加速功能,需要对应 OSS Bucket 已开启传输加速。展开详情 示例值:false |
BypassCacheReadboolean | 文件共享是否启用直读 OSS 功能,不通过网关缓存直接读 OSS 数据。取值范围如下:展开详情 示例值:false |
返回参数
字段名称 | 字段详情 |
---|---|
TaskIdstring | 任务 ID。 示例值:t-000avsri6tlyddgf**** |
Messagestring | 请求结果描述。 示例值:successful |
RequestIdstring | 请求 ID。 示例值:EBAF769F-2E88-4D81-AF1E-A34FAACF9*** |
Codestring | 状态码。状态码为 200 表示请求成功。 示例值:200 |
Successboolean | 请求是否成功。 示例值:true |