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

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

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

调试

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

请求参数

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

系统规定参数。取值:UpdateGatewayFileShare。

GatewayId String gw-000c6hshwukkbrypj***

网关ID。

IndexId String NFStest

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

Name String name

文件共享名称。长度限制1~255个字符,可以包含小写字母,数字,“.”,“_”或“-”,同时必须以小写字母开头。

RemoteSync Boolean true

文件共享是否打开反向同步。

默认值:false。

RemoteSyncDownload Boolean false

复制模式情况下, 是否下载文件数据。

默认值:false。

<note>只有当该共享打开了反向同步或者加入极速同步组时候,这个参数才生效。</note>

<note>网关版本>=1.3.0以上支持。</note>

PollingInterval Integer 36000

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

  • 15 ~ 36000

<note>在复制模式+反向同步启用下载文件数据时,取值范围3600 ~ 36000。</note>

IgnoreDelete Boolean true

文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。

默认值:false。

<note>网关版本>=1.0.40以上支持。</note>

FrontendLimit Integer 0

文件共享最大写入速度。单位:MB/s。0代表无限制。取值范围:

  • 0 ~ 1280。

默认值:0。

BackendLimit Integer 0

文件共享最大上传速度。单位:MB/s。0代表无限制。 取值范围:

  • 0 ~ 1280。

默认值:0。

<note>同时如果已限制最大写入速度,最大上传速度不能小于最大写入速度 。</note>

DownloadLimit Integer 0

文件共享最大下载速度。单位:MB/s。0代表无限制,只在复制模式且开启下载文件数据的情况下才可设置。取值范围:

  • 0~ 1280。

<note>只有当该共享打开了反向同步或者加入极速同步组时候,这个参数才生效。</note>

<note>网关版本>=1.3.0以上支持。</note>

InPlace Boolean false

文件共享是否碎片优化。

默认值:false。

CacheMode String Cache

文件共享缓存模式 。取值范围:

  • Cache:缓存模式。
  • Sync:复制模式。
Browsable Boolean false

文件共享SMB协议下是否可浏览(即网络邻居中是否可发现)。该参数在NFS协议下无效。

默认值:true。

Squash String none

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

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

默认值:none。

ReadWriteUserList String user1,user2

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

<note>该参数在NFS协议下无效。</note>

ReadOnlyUserList String user1,user2

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

<note> 该参数在NFS协议下无效。</note>

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。

<note>网关版本>=1.0.40以上支持。</note>

DirectIO Boolean false

文件共享是否启用DirectIO(直接I/O方式进行数据传输)。

默认值:false。

ServerSideEncryption Boolean false

文件共享是否启用服务端加密。

默认值:false。

<note> 需要联系我们开启白名单后才可进行相关设置,同时服务端加密和客户端加密不可同时配置。</note>

ServerSideCmk String b1e08822-1e9c-4f8e-9dd1-a740cb200***

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

<note>KMS key必须是和网关处于相同region下。</note>

ClientSideEncryption Boolean false

文件共享是否启用客户端加密。

默认值:false。

<note> 需要联系我们开启白名单后才可进行相关设置,且只支持增强型以上的线上网关, 同时服务端加密和客户端加密不可同时配置。</note>

ClientSideCmk String b1e08822-1e9c-4f8e-9dd1-a740cb200***

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

<note>KMS key必须是和网关处于相同region下。</note>

KmsRotatePeriod Long 0

文件共享启用客户端加密情况下,密钥轮转时间周期。 单位为秒。0代表不轮转。轮转的取值范围:

  • 3600 ~ 360
    • 86400。

默认值:0。

FastReclaim Boolean true

文件共享是否开启上传优化,适合数据纯备份上云场景。

默认值:false。

<note>网关版本>=1.0.39以上支持。</note>

WindowsAcl Boolean false

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

默认值:false。

<note>网关版本>=1.0.45以上支持。</note>

AccessBasedEnumeration Boolean false

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

默认值:false。

<note>网关版本>=1.0.45以上支持。</note>

NfsV4Optimization Boolean true

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

默认值:false。

<note>开启后将不支持NFS v3形式挂载,网关版本>=1.2.0以上支持。</note>

TransferAcceleration Boolean false

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

<note>网关版本>=1.3.0以上支持。</note>

返回数据

名称 类型 示例值 描述
Code String 200

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

Message String successful

请求结果描述。

RequestId String EBAF769F-2E88-4D81-AF1E-A34FAACF9***

请求ID。

Success Boolean true

请求是否成功。

TaskId String t-000avsri6tlyddgfe***

任务ID。

示例

请求示例

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

正常返回示例

XML 格式

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

JSON 格式

{
    "TaskId": "t-000avsri6tlyddgfe***",
    "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. 网关文件共享参数于当前网关版本不支持,请检查。

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