接口介绍
创建文件系统
接口约束
- 用户vpc/subnet资源可用
- regionID资源池须支持sfsType类型的弹性文件
- 如若使用isEncrypt加密,用户kmsUUID资源可用,仅支持对称加密密钥,具体请参考加密
- 底层集群剩余可用空间大于sfsSize,sfsSize大小区间为[500GB, 32768GB]
- 用户配额大小默认为50TB
- onDemand为false 时必须指定cycleCount。cycleCount周期最大长度不能超过3年
- 资源池信息为"regionVersion": "v4.0"时,新开通的文件系统会自动绑定默认权限组
- 郴州2、上海7、南京3、成都4等4个资源池仅支持500GB、1TB、2TB、3TB、5TB、10TB、20TB、30TB等固定规格,弹性文件服务支持的资源池请参考支持的资源池
URI
POST /v4/sfs/new-sfs
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | 参考响应示例 | |
regionID | 是 | String | 资源池 ID,例:100054c0416811e9a6690242ac110002 | 参考响应示例 | |
isEncrypt | 否 | Boolean | 是否加密盘,true/false,默认 false,仅支持对称加密密钥 | 参考响应示例 | |
kmsUUID | 否 | String | 如果是加密盘,需要提供 kms 的 uuid | 参考响应示例 | |
projectID | 否 | String | 资源所属企业项目 ID,默认为"0" | 参考响应示例 | |
sfsType | 是 | String | 弹性文件类型,capacity/performance/massive/hpfs_perf | 参考响应示例 | |
sfsProtocol | 是 | String | 协议类型,nfs/cifs, nfs 适用于 linux,cifs 适用于 windows | 参考响应示例 | |
sfsName | 是 | String | 弹性文件名。单账户单资源池下,命名需唯一 | 参考响应示例 | |
sfsSize | 是 | Integer | 大小,单位 GB,最小 500GB | 参考响应示例 | |
onDemand | 否 | Boolean | 是否按需下单。true/false,默认为 true | 参考响应示例 | |
cycleType | 否 | String | 包周期(subscription)类型,year/month。onDemand 为 false 时,必须指定 | 参考响应示例 | |
cycleCount | 否 | Integer | 包周期数。onDemand 为 false 时必须指定。周期最大长度不能超过3年 | 参考响应示例 | |
azName | 否 | String | 多可用区资源池下,必须指定可用区。资源池信息"regionVersion": "v4.0"时为必填项 | 参考响应示例 | |
vpc | 是 | String | 虚拟网ID | 参考响应示例 | |
subnet | 是 | String | 子网ID | 参考响应示例 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
message | String | 响应描述,一般为英文描述 | SUCCESS | |
description | String | 响应描述,一般为中文描述 | 成功 | |
returnObj | Object | 参考returnObj | 参考returnObj | 表returnObj |
errorCode | String | 业务细分码,为 product.module.code 三段式码 | 参考结果码 | |
error | String | 业务细分码,为product.module.code三段式码大驼峰形式 | 参考结果码 | |
errorDetail | Object | 错误明细。一般情况下,会对订单侧(bss)的弹性文件订单业务相关的错误做明确的错误映射和提升,有唯一对应的errorCode。其他订单侧(bss)的错误,以sfs.order.procFailed的errorCode统一映射返回,并在errorDetail中返回订单侧的详细错误信息 |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 订单 ID。调用方在拿到 masterOrderID 之后,在若干错误情况下,可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 | |
masterOrderNO | String | 订单号 | 参考响应示例 | |
masterResourceID | String | 主资源 ID | 参考响应示例 | |
masterResourceStatus | String | 主资源状态 | 参考响应示例 | |
regionID | String | 资源所属资源池 ID | 参考响应示例 | |
resources | Array of Object | 资源明细 | 参考响应示例 | 表resources |
表resources
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
resourceID | String | 单项资源的变配、续订、退订等需要该资源项的 ID。比如某个云主机资源作为主资源,对其挂载 | 参考响应示例 |
resourceType | String | 资源类型。SFS_TURBO/SFS_TURBOC/HPFS/OceanFS/OceanFS_C | 参考响应示例 |
orderID | String | 无需关心 | 参考响应示例 |
startTime | Integer | 启动时刻,epoch 时戳,毫秒精度。例:1589869069561 | 参考响应示例 |
createTime | Integer | 创建时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
updateTime | Integer | 更新时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
status | Integer | 资源状态,无需关心。 | 参考响应示例 |
isMaster | Boolean | 是否是主资源项 | 参考响应示例 |
itemValue | Integer | 无需关心 | 参考响应示例 |
sfsUID | String | 弹性文件系统内部唯一 ID | 参考响应示例 |
sfsStatus | String | 弹性文件状态。creating/available/unusable/delete_error/deleting | 参考响应示例 |
masterOrderID | String | 订单 ID | 参考响应示例 |
sfsName | String | 弹性文件名字 | 参考响应示例 |
masterResourceID | String | 主资源 ID | 参考响应示例 |
resourceConfig | Array of Object | 资源开通相关信息,无需关心 | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
'azName': 'az1',
'subnet': 'subnet-32m8794aev',
'vpc': 'vpc-2ophm4xirb',
'sfsProtocol': 'nfs',
'sfsSize': 500,
'clientToken': 'test-new-sfs-2023-0314-1658-token',
'sfsType': 'performance',
'regionID': '81f7728662dd11ec810800155d307d5b',
'sfsName': 'sfs-2023-0314-1658'
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "8722c040c2fd11edaca10242ac110006",
"masterResourceID": "4f0c85264fdc4f16b17265578decfa3c",
"masterOrderNO": null,
"resources": [
{
"orderID": "c6c443ed67994a31aab528e33fead86c",
"status": 2,
"isMaster": true,
"sfsStatus": "available",
"resourceType": "SFS_TURBO",
"resourceID": "4f0c85264fdc4f16b17265578decfa3c",
"masterOrderID": "8722c040c2fd11edaca10242ac110006",
"updateTime": 1678863487000,
"masterResourceID": "4f0c85264fdc4f16b17265578decfa3c",
"itemValue": 1,
"startTime": 1678863483000,
"sfsName": "sfs-2023-0314-1658",
"createTime": 1678862971000,
"sfsUID": "68209584-b16b-5df2-b028-7f86c99a1bab"
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 说明 |
---|---|
200 | 表示请求成功 |
错误码
请参考错误码