链接复制成功!
创建文件系统 - CreateShare
功能介绍
创建文件系统。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/sfs-turbo/shares
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| share | 是 | Share object | 参数解释: 创建文件系统的请求参数结构体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| bss_param | 否 | BssInfo object | 参数解释: 包周期付费模式需要填写该参数,包含订购周期、自动续费、自动扣款等包周期计费相关拓展参数。 约束限制: 仅包周期计费场景下需传入,按需计费无需配置该参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| availability_zone | 是 | String | 参数解释: 文件系统所在可用区(AZ)的编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 文件系统描述信息。 约束限制: 长度为0~255的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
| enterprise_project_id | 否 | String | 参数解释: 创建SFS Turbo文件系统时,给文件系统绑定的企业项目ID。 关于企业项目ID的获取及企业项目特性的详细信息,请参考查询企业项目列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| metadata | 否 | Metadata object | 参数解释: 文件系统扩展元数据配置集合,以键值对形式组织,用于传递加密密钥、扩展类型、专属部署规格等文件系统进阶属性。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| name | 是 | String | 参数解释: SFS Turbo文件系统的名称。 约束限制: 取值范围: 不涉及。 默认取值: 不涉及。 |
| security_group_id | 是 | String | 参数解释: 用户在当前区域下的安全组ID。 约束限制: 安全组需放通文件系统对应的NFS/CIFS协议端口,否则会导致挂载失败。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_proto | 是 | String | 参数解释: 文件系统的共享协议类型,包括NFS(Network File System)网络文件系统和CIFS(Common Internet File System)通用Internet文件系统两种协议。其中CIFS协议是SMB协议的方言(定义特定版本的协议的消息数据包集称为方言)。 约束限制: 取值范围: 默认取值: 不涉及。 |
| share_type | 是 | String | 参数解释: SFS Turbo文件系统的性能规格类型,用于标识文件系统的性能等级与所属规格系列,不同规格对应不同的带宽、时延等存储性能表现。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| size | 是 | Integer | 参数解释: 文件系统容量,单位为GiB。 约束限制: 不同规格类型需搭配对应metadata参数,部分类型容量需按指定基数取整。 取值范围:
默认取值: 不涉及。 |
| subnet_id | 是 | String | 参数解释: 文件系统所在VPC下的子网网络ID。 约束限制: 子网需与文件系统在同一可用区,创建单个SFS Turbo至少预留21个空闲可用IP。 取值范围: 不涉及。 默认取值: 不涉及。 |
| vpc_id | 是 | String | 参数解释: 用户在当前区域下的VPC ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| backup_id | 否 | String | 参数解释: 备份ID,用于从备份创建文件系统。可通过云备份服务的查询所有备份接口获取备份ID。 约束限制: 从备份创建文件系统时该参数为必选。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tags | 否 | Array of ResourceTag objects | 参数解释: 使用同一标签标识多种云资源,即所有服务均可在标签输入框下拉选择同一标签。 约束限制: 单个文件系统最多可以创建20个标签,标签的key需要唯一,重复的key会做去重操作。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| crypt_key_id | 否 | String | 参数解释: KMS服务专业版密钥ID,用于创建加密文件系统。详细信息请参考密码管理概述。 约束限制: 需确保当前账号具备该密钥的使用权限。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dedicated_flavor | 否 | String | 参数解释: 专属文件系统对应的虚拟机规格。 约束限制: 创建专属文件系统时为必选,需与专属存储池规格匹配。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dedicated_storage_id | 否 | String | 参数解释: 创建专属文件系统时,需指定专属分布式存储的ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| expand_type | 否 | String | 参数解释: 扩展类型。当文件系统正在创建时,该字段不返回。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| hpc_bw | 否 | String | 参数解释: HPC型文件系统的带宽规格。 约束限制: 创建20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型等类型的文件系统时,该参数必填。 取值范围: 默认取值: 不涉及。 |
| auto_create_security_group_rules | 否 | String | 参数解释: 是否自动创建安全组规则。 约束限制: 设置为true时,系统会自动在指定安全组中添加NFS/CIFS协议所需的入方向规则。 取值范围: 默认取值: true |
| vault_id | 否 | String | 参数解释: 云备份存储库ID,用于创建文件系统时绑定备份存储库。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签的键。 约束限制: 取值范围: 不涉及。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 标签的值。 约束限制: 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| is_auto_renew | 否 | Long | 参数解释: 是否自动续费。 约束限制: 包周期计费场景下该参数生效。 取值范围: 默认取值: 0 |
| period_num | 是 | Long | 参数解释: 包周期订购的周期数。 约束限制: 包周期计费场景下该参数为必选。 取值范围: 默认取值: 不涉及。 |
| period_type | 是 | Long | 参数解释: 包周期的类型。 约束限制: 包周期计费场景下该参数为必选。 取值范围: 默认取值: 不涉及。 |
| is_auto_pay | 否 | Long | 参数解释: 是否生成订单后自动扣款。 约束限制: 包周期计费场景下该参数生效。 取值范围: 默认取值: 0 |
响应参数
状态码:202
请求示例
-
创建一个名称为“sfs-turbo-test”的SFS Turbo标准型文件系统,共享协议为NFS,容量为500GB,文件系统所在的可用区编码是example。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”,子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”,VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "example", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 500, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx" } } -
专属场景:创建一个名称为“sfs-turbo-dedicated-test”的SFS Turbo标准型文件系统,共享协议为NFS,容量为500GB,文件系统所在的可用区编码是example。指定专属的存储池id为“198f0704-xxx-4d85-xxx-c25caa4d3264”,专属的ecs规格为"c6.xlarge.2",安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”,子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”,VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-dedicated-test", "availability_zone" : "example", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 500, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx", "metadata" : { "dedicated_flavor" : "c6.xlarge.2", "dedicated_storage_id" : "198f0704-xxx-4d85-xxx-c25caa4d3264" } } } -
125MB/s/TiB:创建一个名称为“sfs-turbo-test”的SFS Turbo 125MB/s/TiB 文件系统,共享协议为NFS,容量为3686GB,规格类型为125MB/s/TiB,文件系统所在的可用区编码是example。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”,子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”,VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "example", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 3686, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx", "metadata" : { "expand_type" : "hpc", "hpc_bw" : "125M" } } } -
100MB/s/TiB-智算型:创建一个名称为“sfs-turbo-test”的SFS Turbo 100MB/s/TiB-智算型文件系统,共享协议为NFS,容量为532480GB, 文件系统所在的可用区编码是example。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”,子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”,VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "example", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "aits.100M", "size" : 532480, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx" } }
响应示例
状态码:202
{
"id" : "708c017c-54b5-429a-a098-7692e23fa518",
"name" : "sfs-turbo-test",
"status" : "100"
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | 创建请求下发成功返回body。 |
错误码
请参见错误码。