更新时间:2024-11-12 GMT+08:00
分享

创建文件系统

功能介绍

创建文件系统。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/sfs-turbo/shares

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

账号的token

Content-Type

String

MIME类型

表3 请求Body参数

参数

是否必选

参数类型

描述

share

Share object

创建文件系统参数body

bss_param

BssInfo object

包周期付费模式,需要填写该参数

表4 Share

参数

是否必选

参数类型

描述

availability_zone

String

文件系统所在可用区(az)的编码

description

String

文件系统描述信息,长度为0~255。当前不支持。

enterprise_project_id

String

创建文件系统时,给文件系统绑定的企业项目ID。

metadata

Metadata object

创建文件系统的metadata信息,一到多个字典形式组织的键值对组成。

name

String

SFS Turbo文件系统的名称。长度为4~64位,必须以字母开头,可以包含字母、数字、中划线、下划线,不能包含其他的特殊字符,不区分大小写。

security_group_id

String

用户在某一区域下的安全组ID。

share_proto

String

文件系统共享协议,有效值为NFS。NFS(Network File System),即网络文件系统。一种使用于分散式文件系统的协议,通过网络让不同的机器、不同的操作系统能够彼此分享数据。

share_type

String

文件系统类型,有效值为STANDARD或者PERFORMANCE。当文件系统正在创建时,该字段不返回。

  • SFS Turbo上一代文件系统规格类型:标准型和标准型增强版填写STANDARD,性能型和性能型增强版填写PERFORMANCE。

  • 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/TiB:不校验该字段,填写STANDARD或者PERFORMANCE。

  • HPC缓存型:不校验该字段,填写STANDARD或者PERFORMANCE。

size

Integer

  • SFS Turbo上一代文件系统规格类型-文件系统容量:取值范围为500~32768,单位为GiB。

  • SFS Turbo上一代文件系统规格类型-增强版文件系统:在“metadata”字段中设置了expand_type="bandwidth",则容量范围为10240~327680,单位为GiB。

  • 20MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="20M",则容量范围为3686~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • 40MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="40M",则容量范围为1228~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • 125MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="125M",则容量范围为1228~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • 250MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="250M",则容量范围为1228~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • 500MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="500M",则容量范围为1228~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • 1000MB/s/TiB:在“metadata”字段中设置了expand_type="hpc"、hpc_bw="1000M",则容量范围为1228~1048576,单位为GiB。容量必须为1.2TiB的倍数,换算为GiB后需要向下取整。如3.6TiB->3686GiB, 4.8TiB->4915GiB,8.4TiB->8601GiB。

  • HPC缓存型文件系统:在“metadata”字段中设置了expand_type="hpc_cache",则容量范围为4096~1048576,单位为GiB。不同带宽,起步容量不一样,步长均为1TiB。如2GB/s带宽,起步容量为4TiB,即4096GiB;4GB/s带宽,起步容量为8TiB,即8192GiB;8GB/s带宽,起步容量为16TiB,即16384GiB。

subnet_id

String

用户在VPC下面的子网的网络ID。

vpc_id

String

用户在某一区域下的VPC ID。

backup_id

String

备份ID,从备份创建文件系统时为必选。

tags

Array of ResourceTag objects

tag标签的列表。

表5 Metadata

参数

是否必选

参数类型

描述

crypt_key_id

String

要创加密文件系统,该字段传KMS服务专业版密钥的ID。

dedicated_flavor

String

创专属文件系统,要创建的虚拟机的规格。

dedicated_storage_id

String

创专属文件系统,要指定一个专属分布式存储的ID。

expand_type

String

扩展类型;当文件系统正在创建时,该字段不返回。

  • 创建增强型、20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统时,该参数必填。

  • 创建增强型的文件系统,包括标准型-增强版和性能型-增强版,需要填写"bandwidth"。

  • 创建20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB文件系统,需要填写"hpc"。

  • 创建HPC缓存型,需要填写"hpc_cache"。

hpc_bw

String

文件系统的带宽规格。

创建20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统时,该参数必填。

20MB/s/TiB,填写"20M"。 40MB/s/TiB,填写"40M"。 125MB/s/TiB,填写"125M"。 250MB/s/TiB,填写"250M"。 500MB/s/TiB,填写"500M"。 1000MB/s/TiB,填写"1000M"。 HPC缓存型,填写"2G"、"4G"、"8G"、"16G"、"24G"、"32G"或"48G"。

表6 ResourceTag

参数

是否必选

参数类型

描述

key

String

标签的键。

最大长度128个字符。

key不能为空,不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字,特殊字符"-"和"_"。

value

String

标签的值。

每个值最大长度255个字符,可以为空字符串。

不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字,特殊字符"-"和"_"。

表7 BssInfo

参数

是否必选

参数类型

描述

is_auto_renew

Long

是否自动续费

period_num

Long

包周期订购的周期数

period_type

Long

包周期的类型,可选包年或包月,2 表示包月,3 表示包年

is_auto_pay

Long

是否生成订单后自动扣款

响应参数

状态码: 202

表8 响应Body参数

参数

参数类型

描述

id

String

创建的SFS Turbo文件系统ID。

name

String

创建的SFS Turbo文件系统名称。

status

String

SFS Turbo文件系统的状态

请求示例

  • SFS Turbo上一代文件系统规格类型:

    创建一个名称为“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上一代文件系统规格类型+专属场景:

    创建一个名称为“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"
        }
      }
    }

响应示例

状态码: 202

创建请求下发成功返回body。

{
  "id" : "708c017c-54b5-429a-a098-7692e23fa518",
  "name" : "sfs-turbo-test",
  "status" : "100"
}

状态码

状态码

描述

202

创建请求下发成功返回body。

错误码

请参见错误码

相关文档