接口功能介绍
在某个网关上创建一个共享，使用该网关已创建的缓存盘和挂载用户的存储桶
接口约束
1、用户账户下至少有一个已创建的网关且状态为运行中
2、该网关下需要有未使用状态的缓存盘，网关所在区域已经开通对象存储服务，且创建有对象存储（ZOS）桶（不支持在归档型、加密的桶上创建共享）
3、当网关处在中间状态（部署中、删除中）和已过期状态时，无法创建共享
4、当缓存盘处于中间状态（部署中、删除中）和已过期状态时，无法创建共享
URI
POST /v4/nfs/create-share
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| shareName | 是 | String | 用户自定义的共享名称，必须大小写字母或中文开头，支持中文，英文大小写，数字，“.”，“_”或“-”，长度不超过50个字符 | 参考请求示例 | |
| protocol | 否 | String | 网关支持的协议，①nfs：nfs协议（目前默认且仅支持nfs协议） | 参考请求示例 | |
| bucket | 是 | String | 指定需要挂载的对象存储桶的名称 | 参考请求示例 | |
| cacheDiskID | 是 | String | 指定挂载缓存盘的ID | 参考请求示例 | |
| userMapping | 否 | String | 用户映射类型，①none，默认为none类型；②root_squash；③all_squash | 参考请求示例 | |
| subdir | 否 | String | 挂载子目录的路径，目录名称使用符合要求的UTF-8字符，不允用表情符；不要以/开头或者结尾；不能包含反斜杠；不要出现连续的/；不允许出现以..开头的子目录；总长度控制在254个字符之内；支持创建多层级目录，并以单个斜杠(/)分离（置空则为挂载桶根目录，输入目录若无文件夹则自动创建该路径目录挂载，默认挂载桶根目录） | 参考请求示例 | |
| endpoint | 否 | String | 对象存储endpoint | 参考请求示例 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| message | String | 状态描述 | SUCCESS | |
| description | String | 状态描述，一般为中文 | 成功 | |
| returnObj | Object | 响应对象 | ||
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"bucket":"bucket-f22b",
"regionID":"81f7728662dd11ec810800155d307d5b",
"shareName":"jintianshi0219",
"protocol":"nfs",
"cacheDiskID":"ef8e224e-c4c5-11ee-ae9f-18022d1723b2",
"userMapping":"none",
"subdir":"",
"endpoint":""
}
响应示例
{
"returnObj":{
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
