接口说明
使用该接口时,需要注意如下事项:
-
您已经创建部署完成文件网关,并且该网关拥有未被使用的缓存盘。
-
您拥有对象存储(OSS)的 Bucket。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
GatewayIdstring | 网关 ID。 示例值:gw-000eg44nmxbsfwbvq***参考取值来源: ModifyGateway CreateGateway DescribeGateways |
Namestring | 文件共享名称。长度限制 1~255 个字符,可以包含小写字母,数字,“.”,“_”或“-”,同时必须以小写字母开头。 示例值:alex*** |
ShareProtocolstring | 文件共享协议。取值范围:展开详情 示例值:NFS |
RemoteSyncboolean | 文件共享是否打开反向同步。取值范围如下:展开详情 示例值:false |
PollingIntervalinteger<int32> | 文件共享反向同步时间间隔。取值范围为 15~36000。展开详情 示例值:4500 |
IgnoreDeleteboolean | 文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。展开详情 示例值:false |
FrontendLimitinteger<int32> | 文件共享最大写入速度,单位为 MB/s。取值范围为 0~1280,默认值为 0,表示无限制。 示例值:1234 |
BackendLimitinteger<int32> | 文件共享最大上传速度,单位为 MB/s。取值范围为 0~1280,默认值为 0,表示无限制。展开详情 示例值:1234 |
InPlaceboolean | 已废弃,不建议设置。 示例值:false |
CacheModestring | 文件共享缓存模式。取值范围如下:展开详情 示例值:Cache |
Browsableboolean | 文件共享 SMB 协议下是否可浏览(即网络邻居中是否可发现),取值范围如下:展开详情 示例值:true |
Squashstring | 文件共享 NFS 协议下用户映射。取值范围如下:展开详情 示例值:none |
ReadWriteUserListstring | 文件共享 SMB 协议下读写用户列表。多个用户使用逗号“,”分隔。展开详情 示例值:user1,user2 |
ReadOnlyUserListstring | 文件共享 SMB 协议下只读用户列表。多个用户使用逗号“,”分隔。展开详情 示例值:userA,userB |
ReadWriteClientListstring | 文件共享 NFS 协议下读写客户端列表(可以是 IP 地址或者 IP 地址范围)。多个客户端使用逗号“,”分隔。 示例值:12.12.12.12 |
ReadOnlyClientListstring | 文件共享 NFS 协议下只读客户端列表(可以是 IP 地址或者 IP 地址范围)。多个客户端使用“,”分隔。 示例值:12.12.12.12 |
OssBucketNamestring | 文件共享对应的对象存储(OSS)Bucket 名称。展开详情 示例值:testbucket |
OssEndpointstring | 文件共享对应的对象存储(OSS)Bucket 所在地域节点。展开详情 示例值:oss-cn-hangzhou-internal.aliyuncs.com |
OssBucketSslboolean | 文件共享是否启用 SSL 访问 OSS Bucket。取值范围如下:展开详情 示例值:true |
LagPeriodinteger<int64> | 同步延迟,即网关本地缓存同步到云上 OSS 的延迟时间。单位为秒。取值范围为 5~120,默认值为 5。展开详情 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:5 |
DirectIOboolean | 文件共享是否启用 DirectIO(直接 I/O 方式进行数据传输)。取值范围如下:展开详情 示例值:false |
LocalFilePathstring | 文件共享使用的缓存盘内部设备名,可以通过 DescribeGatewayCaches 接口获取。 示例值:/dev/vdb |
ServerSideEncryptionboolean | 文件共享是否启用服务端加密。取值范围如下:展开详情 示例值:false |
ServerSideCmkstring | 文件共享启用服务端加密情况下,加密所使用的 KMS key。展开详情 示例值:xxxxx |
ClientSideEncryptionboolean | 废弃。 示例值:false |
ClientSideCmkstring | 废弃。 示例值:xxxxx |
KmsRotatePeriodinteger<int64> | 废弃。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:0 |
PathPrefixstring | 文件共享对应的对象存储(OSS)Bucket 下的子目录路径。为空则代表对应的是 Bucket 的根目录。 示例值:test1 |
FastReclaimboolean | 文件共享是否开启上传优化,适合数据纯备份上云场景。取值范围如下:展开详情 示例值:false |
SupportArchiveboolean | 已废弃,不建议设置。 示例值:false |
WindowsAclboolean | 文件共享 SMB 协议下,是否开启通过 Windows 访问列表(需要 AD 域)进行权限控制。取值范围如下:展开详情 示例值:false |
AccessBasedEnumerationboolean | 文件共享 SMB 协议下,是否启用 Windows ABE,需要 windowsAcl 参数设置为 true 情况下生效。取值范围如下:展开详情 示例值:false |
NfsV4Optimizationboolean | 文件共享 NFS 协议下,是否启用 NFS v4 优化,提升挂载上传效率。取值范围如下:展开详情 示例值:false |
TransferAccelerationboolean | 文件共享是否开启传输加速功能,需要对应 OSS Bucket 已开启传输加速。展开详情 示例值:false |
RemoteSyncDownloadboolean | 复制模式情况下,是否下载文件数据。取值范围如下:展开详情 示例值:false |
DownloadLimitinteger<int32> | 文件共享最大下载速度,单位为 MB/s。取值范围为 0~1280,0 表示无限制。展开详情 示例值:0 |
PartialSyncPathsstring | 复制模式下,通过设置目录路径集合,指定仅有这些目录采用复制模式。展开详情 示例值:test1 |
ServerSideAlgorithmstring | 加密算法。取值范围如下:展开详情 示例值:AES256 |
BypassCacheReadboolean | 是否直读 OSS。取值范围如下:展开详情 示例值:false |
BindIPAddrstring | 仅高可用网关使用,设置共享绑定的虚拟挂载 IP。 示例值:192.168.0.10 |
OssBucketRegionIdstring | 文件共享对应的对象存储(OSS)Bucket 所在地域。展开详情 示例值:cn-hangzhou |
返回参数
字段名称 | 字段详情 |
---|---|
Codestring | 状态码。状态码为 200 表示请求成功。 示例值:200 |
Messagestring | 请求结果描述。 示例值:successful |
RequestIdstring | 请求 ID。 示例值:F8B59F29-453D-49BF-8673-EEB8F9F2D5C6 |
Successboolean | 请求是否成功。 示例值:true |
TaskIdstring | 任务 ID。 示例值:t-000eg44nmxbsh3qk*** |
返回示例
错误码
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2024-12-18 | |||
2024-09-25 |