UpdateGatewayFileShare - 更新文件共享配置

更新时间:2025-05-13 09:09:08

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

接口说明

调用该接口时,您需要注意:

  • 您已经创建部署完成文件网关,并已经完成一个文件共享的配置。

  • 该更新接口会更新文件共享对应的所有暴露参数,如果您不想更新某个参数,请调用时务必传入该参数原值,否则该文件共享参数会被设置成默认值。

调试

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

授权信息

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

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

请求参数

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

网关 ID。

gw-000c6hshwukkbryp****
IndexIdstring

文件共享 ID。可以通过 DescribeGatewayFileShares 接口获得。

NFStest
Namestring

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

name
RemoteSyncboolean

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

  • false(默认):否。

  • true:是。

true
RemoteSyncDownloadboolean

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

  • false(默认):否。

  • true:是。

说明
只有当该共享打开了反向同步或者加入极速同步组时候,这个参数才生效。
false
PollingIntervalinteger

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

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

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

  • false(默认):否。

  • true:是。

说明
网关版本 1.0.40 及以上支持此参数。
true
FrontendLimitinteger

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

0
BackendLimitinteger

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

说明
如果同时已限制最大写入速度,最大上传速度不能小于最大写入速度。
0
DownloadLimitinteger

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

说明
只有当该共享打开了反向同步或者加入极速同步组时,此参数才生效。
0
InPlaceboolean

已废弃,不建议设置。

false
CacheModestring

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

Cache
Browsableboolean

文件共享 SMB 协议下是否可浏览(即网络邻居中是否可发现)。取值范围如下:

  • true(默认):是。

  • false:否。

说明
  • 该参数在 NFS 协议下无效。
  • false
    Squashstring

    文件共享 NFS 协议下用户映射,默认值为 none。取值范围如下:

    • none。

    • root_squash。

    • all_squash。

    • all_anonymous。

    none
    ReadWriteUserListstring

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

    说明
  • 该参数在 NFS 协议下无效。
  • user1,user2
    ReadOnlyUserListstring

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

    说明
  • 该参数在 NFS 协议下无效。
  • user1,user2
    ReadWriteClientListstring

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

    172.16.146.100
    ReadOnlyClientListstring

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

    172.16.146.100
    LagPeriodlong

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

    说明
  • 网关版本 1.0.40 及以上支持此参数。
  • 5
    DirectIOboolean

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

    • false(默认):否。

    • true:是。

    false
    ServerSideEncryptionboolean

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

    • false(默认):否。

    • true:是。

    说明
  • 需要联系我们开启白名单后才可进行相关设置。
  • false
    ServerSideCmkstring

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

    说明
    KMS key 必须是和网关处于相同 Region 下。
    b1e08822-1e9c-4f8e-9dd1-a740cb200***
    ClientSideEncryptionboolean

    废弃。

    false
    ClientSideCmkstring

    废弃。

    b1e08822-1e9c-4f8e-9dd1-a740cb200***
    KmsRotatePeriodlong

    废弃。

    0
    FastReclaimboolean

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

    • false(默认):否。

    • true:是。

    说明
    网关版本 1.0.39 及以上支持此参数。
    true
    WindowsAclboolean

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

    • false(默认):否。

    • true:是。

    说明
    网关版本 1.0.45 及以上支持此参数。
    false
    AccessBasedEnumerationboolean

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

    • false(默认):否。

    • true:是。

    说明
  • 网关版本 1.0.45 及以上支持此参数。
  • false
    NfsV4Optimizationboolean

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

    • false(默认):否。

    • true:是。

    说明
  • 开启后将不支持 NFS v3 形式挂载,网关版本 1.2.0 及以上支持此参数。
  • true
    TransferAccelerationboolean

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

    说明
  • 网关版本 1.3.0 及以上支持此参数。
  • false
    BypassCacheReadboolean

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

    • false(默认):否。

    • true:是。

    说明
  • 不建议开启此功能。
  • false
    ServerSideAlgorithmstring

    加密算法。取值范围如下:

    • AES256(默认)。

    • SM4。

    AES256

    返回参数

    名称类型描述示例值
    名称类型描述示例值
    object
    TaskIdstring

    任务 ID。

    t-000avsri6tlyddgf****
    Messagestring

    请求结果描述。

    successful
    RequestIdstring

    请求 ID。

    EBAF769F-2E88-4D81-AF1E-A34FAACF9***
    Codestring

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

    200
    Successboolean

    请求是否成功。

    true

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    • 接口说明
    • 调试
    • 授权信息
    • 请求参数
    • 返回参数
    • 示例
    • 错误码
    • 变更历史
    AI助理

    点击开启售前

    在线咨询服务

    你好,我是AI助理

    可以解答问题、推荐解决方案等