调用CreateGatewayFileShare在文件网关下创建一个文件共享。

使用该接口时,需要注意如下事项:

  • 您已经创建部署完成文件网关,并且该网关拥有未被使用的缓存盘。
  • 您拥有对象存储(OSS)的Bucket。

调试

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

请求参数

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

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

GatewayId String gw-000eg44nmxbsfwbvq***

网关ID。

LocalFilePath String /dev/vdb

文件共享使用的缓存盘内部设备名, 可以通过DescribeGatewayCaches接口得到。

Name String alex***

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

OssBucketName String testbucket

文件共享对应的对象存储(OSS) Bucket名称。

<note>文件共享不支持“回源特性”OSS Bucket。</note>

OssEndpoint String oss-cn-hangzhou-internal.aliyuncs.com

文件共享对应的对象存储(OSS) Bucket所在Endpoint。

<note>区分内网及外网Endpoint。建议如果OSS Bucket和网关处于相同Region则使用内网Endpoint:oss-cn-hangzhou-internal.aliyuncs.com。</note>

ShareProtocol String NFS

文件共享协议。取值范围:

  • NFS。
  • SMB。
RemoteSync Boolean false

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

默认值:false。

PollingInterval Integer 4500

文件共享反向同步时间间隔。取值范围:

  • 15 ~ 36000。

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

IgnoreDelete Boolean false

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

默认值:false。

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

FrontendLimit Integer 1234

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

  • 0 ~ 1280。

默认值:0。

BackendLimit Integer 1234

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

  • 0 ~ 1280。

默认值:0。

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

InPlace Boolean false

文件共享是否碎片优化。

默认值:false。

CacheMode String Cache

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

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

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

默认值:true。

Squash String none

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

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

默认值:none。

ReadWriteUserList String user1,user2

文件共享SMB协议下读写用户列表。多个用户使用逗号“,”分隔。该参数在NFS协议下无效。

ReadOnlyUserList String userA,userB

文件共享SMB协议下只读用户列表。多个用户使用逗号“,”分隔。该参数在NFS协议下无效。

ReadWriteClientList String 12.12.12.12

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

ReadOnlyClientList String 12.12.12.12

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

OssBucketSsl Boolean true

文件共享是否启用SSL访问OSS Bucket。

默认值:true。

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 xxxxx

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

<note>注意:这个KMS key必须是和网关处于相同Region下。</note>

ClientSideEncryption Boolean false

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

默认值:false。

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

ClientSideCmk String xxxxx

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

<note>注意:这个KMS key必须是和网关处于相同Region下。</note>

KmsRotatePeriod Long 0

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

  • 3600~ 360
    • 86400。

默认值:0。

PathPrefix String test1

文件共享对应的对象存储(OSS) Bucket下的子目录路径。为空则代表对应的是Bucket的根目录。

FastReclaim Boolean false

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

默认值:false。

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

SupportArchive Boolean false

文件共享NFS协议下,是否开启支持归档文件访问。

<note>开启支持情况下访问归档文件需要一定解冻时间,但不报错, 非开启情况下,访问归档文件会报错。</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 false

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

默认值:false。

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

TransferAcceleration Boolean false

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

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

RemoteSyncDownload Boolean false

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

默认值:false。

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

DownloadLimit Integer 0

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

  • 0 ~ 1280。

<note>只在复制模式且开启下载文件数据的情况下才可设置。</note>

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

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

PartialSyncPaths String test1

复制模式下,通过设置目录路径集合,指定仅有这些目录采用复制模式。

<note>需要联系我们开启白名单后才可进行相关设置。</note>

返回数据

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

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

Message String successful

请求结果描述。

RequestId String F8B59F29-453D-49BF-8673-EEB8F9F2D5C6

请求ID。

Success Boolean true

请求是否成功。

TaskId String t-000eg44nmxbsh3qk***

任务 ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateGatewayFileShare
&GatewayId=gw-000eg44nmxbsfwbvq***
&LocalFilePath=/dev/vdb
&Name=alex***
&OssBucketName=testbucket
&OssEndpoint=oss-cn-hangzhou-internal.aliyuncs.com
&ShareProtocol=NFS
&<公共请求参数>

正常返回示例

XML 格式

<CreateGatewayFileShareResponse>
      <TaskId>t-000eg44nmxbsh3qk***</TaskId>
      <Message>successful</Message>
      <RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</CreateGatewayFileShareResponse>

JSON 格式

{
    "TaskId":"t-000eg44nmxbsh3qk***",
    "Message":"successful",
    "RequestId":"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6",
    "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. 网关文件共享参数于当前网关版本不支持,请检查。

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