弹性文件服务 SFS-创建共享:请求消息

时间：2024-11-05 14:09:44

弹性文件服务 SFS 文件共享

请求消息

参数说明

参数	是否必选	参数类型	描述
share	是	Object	详见share字段说明

share字段说明：

参数	是否必选	参数类型	描述
share_proto	是	String	文件系统共享协议，有效值为NFS（适用于linux系统）。
size	是	Integer	共享容量，单位GB。申请的共享容量不能大于配额值，需要查看配额，请参考配额查询接口。
name	否	String	共享名称，长度为0~255，只支持英文字母、数字、中划线、下划线。
description	否	String	共享描述信息，长度为0~255，只支持英文字母、数字、中划线、下划线。
is_public	否	Boolean	（API 微版本2.8到2.42支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。
availability_zone	否	String	AZ( availability zone)的名称，如果不输入AZ信息，后台会当成默认AZ处理，默认AZ中如果无存储资源，共享创建会失败。长度为0~255。
metadata	否	Object	创建共享的metadata信息，一到多个字典形式组织的键值对组成，见metadata字段说明。注意：出于系统安全考虑，现未开放修改metadata字段的API接口，因此，通过metadata字段创建包含数据加密功能的共享时，请确保相应参数和值正确。 metadata字段中以下规则的键，除非已经明确可以被设置的（例如“#sfs_crypt_key_id”等），其他的为系统内部使用，请勿自定义设置，避免因与系统预定义键冲突导致的系统内部错误：字符串“share_used”。以字符串“#sfs”开头。

metadata字段说明（创建共享，同时共享具有数据加密功能）

创建具有数据加密功能的共享时，请首先参考《数据加密服务API参考》中的“查询密钥列表”章节通过HTTPS请求获取加密密钥的密钥ID、DomainID和密钥别名，然后在metadata字段中设置如下字典形式组织的键值对，请务必确保metadata字段中的键值对正确。

当需要创建具有数据加密功能的共享时，以下参数均为必选。如仅需要创建普通共享时，以下参数均为可选。

键	值类型	是否必选	说明
#sfs_crypt_key_id	String	是	加密密钥ID。该字段与“#sfs_crypt_domain_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。
#sfs_crypt_domain_id	String	是	租户的Domain id。该字段与“#sfs_crypt_key_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。
#sfs_crypt_alias	String	是	加密密钥别名。该字段与“#sfs_crypt_key_id”和“#sfs_crypt_domain_id”字段同时存在时表示启动数据加密功能。

键

值类型

是否必选

说明

#sfs_crypt_key_id

String

是

加密密钥ID。

该字段与“#sfs_crypt_domain_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。

#sfs_crypt_domain_id

String

是

租户的Domain id。

该字段与“#sfs_crypt_key_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。

#sfs_crypt_alias

String

是

加密密钥别名。

该字段与“#sfs_crypt_key_id”和“#sfs_crypt_domain_id”字段同时存在时表示启动数据加密功能。

建议使用弹性文件服务的默认密钥“sfs/default”的来创建加密共享请参考《弹性文件服务用户指南》中的“文件系统加密”章节和“加密”章节获取详细信息和注意事项)。

创建带企业项目ID的共享时，metadata中的键如下：

键	值类型	是否必选	说明
enterprise_project_id	String	是	企业项目ID。在租户开启企业项目功能的情况下，enterprise_project_id作为key，value为企业项目ID，给共享绑定企业项目ID。

键

值类型

是否必选

说明

enterprise_project_id

String

是

企业项目ID。

在租户开启企业项目功能的情况下，enterprise_project_id作为key，value为企业项目ID，给共享绑定企业项目ID。

请求样例：POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares

创建共享，共享协议类型为NFS，共享容量为1GB，共享的可见程度为私有个人可见。

{
   "share": {
       "name": "test",
       "description": "test description",
       "share_proto": "NFS",
       "share_network_id": null,
       "size": 1,
       "is_public": false
   }
}

上一篇：弹性文件服务 SFS-创建共享:功能介绍

下一篇：弹性文件服务 SFS-创建共享:响应消息