调用CreateGatewayFileShare接口在文件网关下创建一个文件共享。
使用该接口时,需要注意如下事项:
- 您已经创建部署完成文件网关,并且该网关拥有未被使用的缓存盘。
- 您拥有对象存储(OSS)的Bucket。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | CreateGatewayFileShare | 系统规定参数。取值:CreateGatewayFileShare。 |
GatewayId | String | 是 | gw-000eg44nmxbsfwbvq*** | 网关ID。 |
Name | String | 是 | alex*** | 文件共享名称。长度限制1~255个字符,可以包含小写字母,数字,“.”,“_”或“-”,同时必须以小写字母开头。 |
ShareProtocol | String | 是 | NFS | 文件共享协议。取值范围:
|
RemoteSync | Boolean | 否 | false | 文件共享是否打开反向同步。取值范围如下:
|
PollingInterval | Integer | 否 | 4500 | 文件共享反向同步时间间隔。取值范围为15~36000。 说明 在复制模式+反向同步启用下载文件数据时,取值范围为3600~36000。 |
IgnoreDelete | Boolean | 否 | false | 文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。
说明 网关版本大于等于1.0.40支持。 |
FrontendLimit | Integer | 否 | 1234 | 文件共享最大写入速度,单位为MB/s。取值范围为0~1280,默认值为0,表示无限制。 |
BackendLimit | Integer | 否 | 1234 | 文件共享最大上传速度,单位为MB/s。取值范围为0~1280,默认值为0,表示无限制。 说明 同时如果已限制最大写入速度,最大上传速度不能小于最大写入速度。 |
InPlace | Boolean | 否 | false | 文件共享是否碎片优化。取值范围如下:
|
CacheMode | String | 否 | Cache | 文件共享缓存模式。取值范围如下:
|
Browsable | Boolean | 否 | true | 文件共享SMB协议下是否可浏览(即网络邻居中是否可发现),该参数在NFS协议下无效。取值范围如下:
|
Squash | String | 否 | none | 文件共享NFS协议下用户映射。取值范围如下:
|
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地址范围)。多个客户端使用“,”分隔。 |
OssBucketName | String | 是 | testbucket | 文件共享对应的对象存储(OSS)Bucket名称。 说明 文件共享不支持“回源特性”OSS Bucket。 |
OssEndpoint | String | 是 | oss-cn-hangzhou-internal.aliyuncs.com | 文件共享对应的对象存储(OSS)Bucket所在Endpoint。 说明 区分内网及外网Endpoint。建议如果OSS Bucket和网关处于相同Region则使用内网Endpoint:oss-cn-hangzhou-internal.aliyuncs.com。 |
OssBucketSsl | Boolean | 否 | true | 文件共享是否启用SSL访问OSS Bucket。取值范围如下:
|
LagPeriod | Long | 否 | 5 | 同步延迟,即网关本地缓存同步到云上OSS的延迟时间。单位为秒。取值范围为5~120,默认值为5。 说明 网关版本大于等于1.0.40支持。 |
DirectIO | Boolean | 否 | false | 文件共享是否启用DirectIO(直接I/O方式进行数据传输)。取值范围如下:
|
LocalFilePath | String | 是 | /dev/vdb | 文件共享使用的缓存盘内部设备名,可以通过DescribeGatewayCaches接口获取。 |
ServerSideEncryption | Boolean | 否 | false | 文件共享是否启用服务端加密。取值范围如下:
说明 需要联系我们开启白名单后才可进行相关设置,同时服务端加密和客户端加密不可同时配置。 |
ServerSideCmk | String | 否 | xxxxx | 文件共享启用服务端加密情况下,加密所使用的KMS key。 说明 这个KMS key必须是和网关处于相同Region下。 |
ClientSideEncryption | Boolean | 否 | false | 文件共享是否启用客户端加密。取值范围如下:
说明 需要联系我们开启白名单后才可进行相关设置,且只支持增强型以上的线上网关,同时服务端加密和客户端加密不可同时配置。 |
ClientSideCmk | String | 否 | xxxxx | 文件共享启用客户端加密情况下,加密所使用的KMS key。 说明 这个KMS key必须是和网关处于相同Region下。 |
KmsRotatePeriod | Long | 否 | 0 | 文件共享启用客户端加密情况下,密钥轮转时间周期,单位为秒。轮转的取值范围为-3600~360*86400,默认值为0,表示不轮转。 |
PathPrefix | String | 否 | test1 | 文件共享对应的对象存储(OSS)Bucket下的子目录路径。为空则代表对应的是Bucket的根目录。 |
FastReclaim | Boolean | 否 | false | 文件共享是否开启上传优化,适合数据纯备份上云场景。取值范围如下:
说明 网关版本大于等于1.0.39支持。 |
SupportArchive | Boolean | 否 | false | 文件共享NFS协议下,是否开启支持归档文件访问。 说明 支持情况下访问归档文件需要一定解冻时间,但不报错,非开启情况下,访问归档文件会报错。 |
WindowsAcl | Boolean | 否 | false | 文件共享SMB协议下,是否开启通过Windows访问列表(需要AD域)进行权限控制。取值范围如下:
说明 网关版本大于等于1.0.45支持。 |
AccessBasedEnumeration | Boolean | 否 | false | 文件共享SMB协议下,是否启用Windows ABE,需要windowsAcl参数设置为true情况下生效。取值范围如下:
说明 网关版本大于等于1.0.45支持。 |
NfsV4Optimization | Boolean | 否 | false | 文件共享NFS协议下,是否启用NFS v4优化,提升挂载上传效率。取值范围如下:
说明 开启后将不支持NFS v3形式挂载。网关版本大于等于1.2.0支持。 |
TransferAcceleration | Boolean | 否 | false | 文件共享是否开启传输加速功能,需要对应OSS Bucket已开启传输加速。 说明 网关版本大于等于1.3.0支持。 |
RemoteSyncDownload | Boolean | 否 | false | 复制模式情况下,是否下载文件数据。取值范围如下:
说明 只有当该共享打开了反向同步或者加入极速同步组时候,此参数才生效。 |
DownloadLimit | Integer | 否 | 0 | 文件共享最大下载速度,单位为MB/s。取值范围为0~1280,0表示无限制。 说明
|
PartialSyncPaths | String | 否 | test1 | 复制模式下,通过设置目录路径集合,指定仅有这些目录采用复制模式。 说明 需要联系我们开启白名单后才可进行相关设置。 |
ServerSideAlgorithm | String | 否 | AES256 | 加密算法。取值范围如下:
|
BypassCacheRead | Boolean | 否 | false | 是否直读OSS。取值范围如下:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
TaskId | String | t-000eg44nmxbsh3qk*** | 任务 ID。 |
Message | String | successful | 请求结果描述。 |
RequestId | String | F8B59F29-453D-49BF-8673-EEB8F9F2D5C6 | 请求ID。 |
Code | String | 200 | 状态码。状态码为200表示请求成功。 |
Success | Boolean | true | 请求是否成功。 |
示例
请求示例
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
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateGatewayFileShareResponse>
<TaskId>t-000eg44nmxbsh3qk***</TaskId>
<Message>successful</Message>
<RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>
<Code>200</Code>
<Success>true</Success>
</CreateGatewayFileShareResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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. | 网关文件共享参数于当前网关版本不支持,请检查。 |
400 | FileShareArchiveSupportConflict | You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none". | 仅在NFS协议且用户映射取值为“none”时候支持设置archiveSupport参数 |
访问错误中心查看更多错误码。