AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云存储网关 开发参考 API参考指南 API目录 文件共享 CreateGatewayFileShare - 创建文件共享

CreateGatewayFileShare - 创建文件共享

更新时间：
产品详情
我的收藏

在文件网关下创建文件共享。

接口说明

使用该接口时，需要注意如下事项：

  • 您已经创建部署完成文件网关，并且该网关拥有未被使用的缓存盘。

  • 您拥有对象存储(OSS)的 Bucket。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:CreateGatewayFileShare

create

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
GatewayId

string

是

网关 ID。

gw-000eg44nmxbsfwbvq***
Name

string

是

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

alex***
ShareProtocol

string

是

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

  • NFS。

  • SMB。

NFS
RemoteSync

boolean

否

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

  • false（默认）：否

  • true：是

false
PollingInterval

integer

否

文件共享反向同步时间间隔。取值范围为 15~36000。

说明

在复制模式+反向同步启用下载文件数据时，取值范围为 3600~36000。

4500
IgnoreDelete

boolean

否

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

  • false（默认）：否

  • true：是

说明

网关版本大于等于 1.0.40 支持。

false
FrontendLimit

integer

否

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

1234
BackendLimit

integer

否

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

说明

同时如果已限制最大写入速度，最大上传速度不能小于最大写入速度。

1234
InPlace

boolean

否

已废弃，不建议设置。

false
CacheMode

string

否

文件共享缓存模式。取值范围如下：

  • Cache：缓存模式

  • Sync：复制模式

Cache
Browsable

boolean

否

文件共享 SMB 协议下是否可浏览（即网络邻居中是否可发现），取值范围如下：

  • true（默认）：是

  • false：否

说明

  • 该参数在 NFS 协议下无效。

true
Squash

string

否

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

  • none（默认）

  • root_squash

  • all_squash

  • all_anonymous

none
ReadWriteUserList

string

否

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

说明

  • 该参数在 NFS 协议下无效。

user1，user2
ReadOnlyUserList

string

否

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

说明

  • 该参数在 NFS 协议下无效。

userA，userB
ReadWriteClientList

string

否

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

12.12.12.12
ReadOnlyClientList

string

否

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

12.12.12.12
OssBucketName

string

是

文件共享对应的对象存储（OSS）Bucket 名称。

说明

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

testbucket
OssEndpoint

string

是

文件共享对应的对象存储（OSS）Bucket 所在地域节点。

说明

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

oss-cn-hangzhou-internal.aliyuncs.com
OssBucketSsl

boolean

否

文件共享是否启用 SSL 访问 OSS Bucket。取值范围如下：

  • true（默认）：是

  • false：否

true
LagPeriod

integer

否

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

说明

网关版本大于等于 1.0.40 支持。

5
DirectIO

boolean

否

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

  • false（默认）：否

  • true：是

false
LocalFilePath

string

是

文件共享使用的缓存盘内部设备名，可以通过 DescribeGatewayCaches 接口获取。

/dev/vdb
ServerSideEncryption

boolean

否

废弃。

false
ServerSideCmk

string

否

废弃。

xxxxx
ClientSideEncryption

boolean

否

废弃。

false
ClientSideCmk

string

否

废弃。

xxxxx
KmsRotatePeriod

integer

否

废弃。

0
PathPrefix

string

否

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

test1
FastReclaim

boolean

否

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

  • false（默认）：否

  • true：是

说明

网关版本大于等于 1.0.39 支持。

false
SupportArchive

boolean

否

已废弃，不建议设置。

false
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 支持。

false
TransferAcceleration

boolean

否

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

说明

网关版本大于等于 1.3.0 支持。

false
RemoteSyncDownload

boolean

否

复制模式情况下，是否下载文件数据。取值范围如下：

  • false（默认）：否

  • true：是

说明

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

false
DownloadLimit

integer

否

文件共享最大下载速度，单位为 MB/s。取值范围为 0~1280，0 表示无限制。

说明

  • 只在复制模式且开启下载文件数据的情况下才可设置。- 只有当该共享打开了反向同步或者加入极速同步组时候，此参数才生效。- 网关版本大于等于 1.3.0 支持。

0
PartialSyncPaths

string

否

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

说明

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

test1
ServerSideAlgorithm

string

否

废弃。

AES256
BypassCacheRead

boolean

否

是否直读 OSS。取值范围如下：

  • true：是

  • false（默认）：否

false
BindIPAddr

string

否

仅高可用网关使用，设置共享绑定的虚拟挂载 IP。

192.168.0.10
OssBucketRegionId

string

否

文件共享对应的对象存储（OSS）Bucket 所在地域。

说明

  • 当网关版本大于等于 2.0.0，并正确传入该参数，网关会使用 OSS v4 签名算法访问 OSS 桶中的数据。

  • 当网关版本小于 2.0.0，或未正确传入该参数，网关会使用 OSS v1 签名算法访问 OSS 桶中的数据。

cn-hangzhou
BucketInfos

array<object>

否

Bucket 信息列表。

说明

  • 此参数仅白名单用户可用。

object

否

Name

string

否

OSS Bucket 名称。

test-aliyun
Endpoint

string

否

OSS Bucket 的 Endpoint。

oss-cn-hangzhou.aliyuncs.com
PathPrefix

string

否

废弃。

test1
BucketStub

boolean

否

是否启用多 Bucket 聚合。取值如下：

  • true：是。

  • false：否。

说明

  • 此参数仅白名单用户可用。

true

返回参数

名称

类型

描述

示例值

object

Code

string

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

200
Message

string

请求结果描述。

successful
RequestId

string

请求 ID。

F8B59F29-453D-49BF-8673-EEB8F9F2D5C6
Success

boolean

请求是否成功。

true
TaskId

string

任务 ID。

t-000eg44nmxbsh3qk***

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "F8B59F29-453D-49BF-8673-EEB8F9F2D5C6",
  "Success": true,
  "TaskId": "t-000eg44nmxbsh3qk***"
}

错误码

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. 网关文件共享参数于当前网关版本不支持，请检查。
400 FileShareArchiveSupportConflict You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none". 仅在NFS协议且用户映射取值为“none”时候支持设置archiveSupport参数

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

变更历史

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

上一篇：文件共享下一篇：DescribeGatewayFileStatus - 查询文件共享下文件的状态