创建共享createShare_文件共享_弹性文件服务API-华为云

华为云计算云知识创建共享createShare

普惠上云 2核2G2M云服务器

38元/年

云服务器新品 X实例-4核8G5M

288元/年

GeminiDB Redis 4GB 游戏广告

19元/年

网站搭建买3年送2年

1元/天

创建共享createShare

时间: 2023-08-24 16:10:55

API网关云服务器云主机云计算弹性伸缩

猜你想看：

华为云耀L实例实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

创建文件共享。创建文件系统成功后,您还需前往弹性云服务器执行挂载操作,才能实现多个云服务器共享文件存储

约束说明

该接口为异步接口,返回为200只是表示接口下发接收成功,后续可以通过6.2.4 查询共享详细信息查询共享的共享状态和共享路径,判断创建共享是否完成以及是否成功,如果共享状态变为available,或者共享路径已经生成,说明创建已经成功。
通过该接口创建共享成功后,用户还需要参考接口"添加共享访问规则添加共享访问规则",之后才可正常使用创建的共享。

URL

POST https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares

请求参数

名称	类型	IN	必选	描述
X-Auth-Token	string	header	是	用户Token。通过调用 IAM 服务获取用
X-Openstack-Manila-Api-Version	float	header	否	指定API微版本号
project_id	string	path	是	操作用户的项目ID

名称

类型

必选

描述

X-Auth-Token

string

header

是

用户Token。

通过调用 IAM 服务获取用

X-Openstack-Manila-Api-Version

float

header

否

指定API微版本号

project_id

string

path

是

操作用户的项目ID

Body参数

名称	类型	必选	描述
share	share object	是	详见share字段说明

参数：

名称	类型	必选	描述
availability_zone	string	否	AZ( availability zone)的名称,如果不输入AZ信息,后台会当成默认AZ处理,默认AZ中如果无存储资源,共享创建会失败。长度为0~255。
consistency_group_id	string	否	(API 微版本2.31到2.42之后支持) 共享将创建到的一致性组的UUID。当前文件服务不支持一致性组,该字段无意义,这个参数不填写。
description	string	否	共享描述信息,长度为0~255,只支持英文字母、数字、中划线、下划线。
is_public	boolean	否	(API 微版本2.8到2.42之后支持)共享的可见程度。设置为true时公共可见,设置为false时私有个人可见,默认值为false。
metadata	Map<String,String>	否	创建共享的metadata信息,一到多个字典形式组织的键值对组成,见share_metadata字段说明。
name	string	否	共享名称,长度为0~255,只支持英文字母、数字、中划线、下划线。
share_network_id	string	否	共享服务所属或即将创建到的共享网络的UUID,长度为0~36,当前不支持共享网络管理,该字段无意义。
share_proto	string	是	文件系统共享协议,有效值为NFS(适用于linux系统)、CIFS(适用于windows系统)。
share_type	string	否	共享类型的名称,共享类型用于指定分配哪些类型的存储服务,例如高性能类型(由SSD磁盘组成)、大容量类型(由SATA盘组成),当前支持一种类型的存储服务,用户不用指定本参数,后台会自动把本参数指定为系统支持的存储类型,用户若要输入系统不支持的服务类型,将导致文件服务申请失败。
size	integer	是	共享容量,单位GB。申请的共享容量不能大于配额值,需要查看配额。
snapshot_id	string	否	创建共享的源快照的UUID,长度为0~36,当前不支持快照,该字段无意义。

返回参数

返回码: 202

Accepted

名称	类型	必选	描述
share	share_response object	是	详细参数说明请参见share_response字段说明

202 share

名称	类型	必选	描述
access_rules_status	string	否	共享访问权限的设置结果,active表示已生效,error表示设置失败,syncing表示正在配置中。(API 微版本2.10以后支持)。
availability_zone	string	是	可用区AZ(availability zone)。
consistency_group_id	string	否	一致性组的UUID,当前不支持一致性组,该字段当前无意义。(API 微版本2.31到2.42以后支持)
create_share_from_snapshot_support	boolean	否	是否支持从快照创建共享,目前不支持快照,该字段无意义。(API 微版本2.24以后支持)。
created_at	string	否	共享创建的时间标签。
description	string	否	共享描述。
export_location	string	否	共享挂载路径,当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9,该字段存在,若为2.9到2.42之间以后,该消息不存在。
export_locations	Array of strings	否	共享挂载路径信息列表,当前只支持有一个共享。当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9,该字段存在,若为2.9到2.42之间以后,该消息不存在。
has_replicas	boolean	否	是否有复制,当前不支持复制,该字段无意义。(API 微版本2.11到2.42以后支持)。
host	string	否	共享主机名,管理员才会显示此字段。
id	string	是	共享的UUID。
is_public	boolean	否	共享的可见程度。设置为true时公共可见,设置为false时私有个人可见,默认值为false。
links	Array of links objects	否	共享链接。
metadata	metadata object	否	一到多个字典形式组织的键值对。其中share_used作为key,对应的value表示共享已经使用的容量,单位是Bytes;enterprise_project_id作为key,对应的value是共享所属的企业项目ID。
mount_snapshot_support	boolean	否	是否支持挂载快照,目前不支持快照,该字段无意义。(API 微版本2.32以后支持)。
name	string	否	共享名称。
project_id	string	是	创建共享的项目的UUID。
replication_type	string	否	复制类型,当前不支持复制,该字段无意义。(API 微版本2.11到2.42以后支持)。
revert_to_snapshot_support	boolean	否	是否支持从快照回滚,目前不支持快照,该字段无意义。(API 微版本2.27以后支持)。
share_network_id	string	否	共享网络的UUID,当前不支持共享网络管理,该字段无意义。
share_proto	string	否	文件系统的共享协议。
share_server_id	string	否	共享服务管理的UUID
share_type	string	否	共享类型的UUID。
share_type_name	string	否	共享类型的名称,共享类型用于指定分配哪些类型的存储服务,例如高性能类型(由SSD磁盘组成)、大容量类型(由SATA盘组成)。(API 微版本2.6以后支持)。
size	integer	是	共享容量,单位GB。
snapshot_id	string	否	创建共享的源快照的UUID,当前不支持快照,该字段当前无意义。
snapshot_support	boolean	否	是否支持快照,当前不支持快照,该字段当前无意义。(API 微版本2.2以后支持)。
source_share_group_snapshot_member_id	string	否	一致性快照源的UUID,当前不支持一致性快照,该字段无意义。(API 微版本2.31以后支持)。
status	string	否	共享的状态。
task_state	string	否	数据迁移状态,当前不支持数据迁移,该字段无意义。(API 微版本2.5以后支持)
user_id	string	否	用户ID。(API 微版本2.16以后支持)。
volume_type	string	否	卷类型,,与share_type含义相同。

请求示例

示例 1

创建共享

"POST https://{endpoint}/v2/{project_id}/shares"

{ "share": { "description": "test description", "is_public": false, "metadata": { "key1": "value1", "key2": "value2" }, "name": "test", "share_network_id": null, "share_proto": "NFS", "share_type": null, "size": 1, "snapshot_id": null } }

返回示例

返回码：202

Accepted

示例 1

{
"share": {
"availability_zone": "az1.dc1",
"created_at": "2015-09-18T10:25:24.533287",
"description": "My custom share London",
"export_location": null,
"export_locations": [],
"host": null,
"id": "011d21e2-fbc3-4e4a-9993-9ea223f73264",
"is_public": true,
"links": [
{
"href": "http://192.168.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "self"
},
{
"href": "http://192.168.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "bookmark"
}
],
"metadata": {
"aim": "doc",
"project": "my_app"
},
"name": "share_London",
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"share_network_id": null,
"share_proto": "NFS",
"share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7",
"size": 1,
"snapshot_id": null,
"status": "creating",
"volume_type": "default"
}
}

错误码

请参考错误码说明。