接口介绍
创建文件系统
接口约束
- 用户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
路径参数
无
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 | 参考请求示例 |
name | 是 | String | 弹性文件名。单账户单资源池下,命名须唯一 | 参考请求示例 |
sfsSize | 是 | Integer | 大小,单位 GB,最小 500GB,1024进制 | 参考请求示例 |
onDemand | 否 | Boolean | 是否按需下单。true/false,默认为 true | 参考请求示例 |
cycleType | 否 | String | 包周期(subscription)类型,year/month。onDemand 为 false 时,必须指定。 | 参考请求示例 |
cycleCount | 否 | Integer | 包周期数。onDemand 为 false 时必须指定。周期最大长度不能超过 5 年 | 参考请求示例 |
azName | 否 | String | 多可用区资源池下,必须指定可用区。4.0资源池必填 | 参考请求示例 |
vpc | 是 | String | 虚拟网 ID | 参考请求示例 |
subnet | 是 | String | 子网 ID | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为订单处理中/失败) | 800 |
message | 否 | String | 失败时的错误描述,一般为英文描述 | 参考结果码 |
description | 否 | String | 失败时的错误描述,一般为中文描述 | 参考结果码 |
returnObj | 是 | Object | returnObj | 参考响应示例 |
errorCode | 否 | String | 业务细分码,为 product.module.code 三段式码 | 参考结果码 |
returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
masterOrderID | 否 | String | 订单 ID。调用方在拿到 masterOrderID 之后,在若干错误情况下,可以使用 materOrderID 进一步确认订单状态及资源状态 |
参考响应示例 |
masterOrderNO | 否 | String | 订单号 | 参考响应示例 |
masterResourceID | 否 | String | 主资源 ID | 参考响应示例 |
masterResourceStatus | 否 | String | 主资源状态。参考主资源状态 | 参考响应示例 |
regionID | 否 | String | 资源池 ID | 参考响应示例 |
resources | 否 | Array of Object | 资源明细 | 参考响应示例 |
resources
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
resourceID | 否 | String | 单项资源的变配、续订、退订等需要该资源项的 ID。比如某个云主机资源作为主资源,对其挂载 | 参考响应示例 |
resourceType | 否 | String | 资源类型 | 参考响应示例 |
orderID | 否 | String | 无需关心 | 参考响应示例 |
startTime | 否 | Integer | 启动时刻,epoch 时戳,毫秒精度。例:1589869069561 | 参考响应示例 |
createTime | 否 | Integer | 创建时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
updateTime | 否 | Integer | 更新时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
status | 否 | Integer | 资源状态 | 参考响应示例 |
isMaster | 否 | Boolean | 是否是主资源项 | 参考响应示例 |
itemValue | 否 | Integer | 无需关心 | 参考响应示例 |
UID | 否 | String | 弹性文件系统内部唯一 ID | 参考响应示例 |
sfsStatus | 否 | Integer | 弹性文件状态序号 | 参考响应示例 |
masterOrderID | 否 | String | 订单 ID | 参考响应示例 |
name | 否 | String | 弹性文件名字 | 参考响应示例 |
masterResourceID | 否 | String | 主资源 ID | 参考响应示例 |
resourceConfig | 否 | Array of Object | 资源开通相关信息,无需关心 | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsType": "performance",
"sfsSize": 512,
"name": "yc-test1-0013",
"vpc": "vpc-x3x26qpagv",
"subnet": "subnet-kmnyn7ih59",
"sfsProtocol": "cifs",
"azName": "az1",
"clientToken": "yc-test--123344",
"onDemand": false,
"cycleType": "month",
"cycleCount": 1
}
响应示例
{
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "bcc0f0c242fc11edb4710242ac110003",
"masterResourceID": "ed95c23eff984a3b82154e164ee03e4e",
"masterOrderNO": null,
"resources": [
{
"orderID": "7a82cff63f07496cae632034c66c486c",
"status": 2,
"isMaster": true,
"UID": null,
"resourceType": "SFS_TURBOC",
"resourceID": "ed95c23eff984a3b82154e164ee03e4e",
"masterOrderID": "bcc0f0c242fc11edb4710242ac110003",
"updateTime": 1664788937000,
"name": null,
"masterResourceID": "ed95c23eff984a3b82154e164ee03e4e",
"itemValue": 1,
"startTime": 1664788936000,
"resourceConfig": {
"protocol": "cifs",
"vpc": "vpc-x3x26qpagv",
"projectID": "0",
"volumetype": "nvme",
"number": "1",
"zoneid": "3d725a58b44e11e99a9a0242ac110002",
"size": "1",
"subnet": "subnet-kmnyn7ih59",
"isauto": "1",
"zone": "",
"regionid": "3d725a58b44e11e99a9a0242ac110002",
"ifautorenew": "false",
"isEncrypted": "False",
"version": "v1",
"zonetype": "2",
"spec": "512",
"yptProductLimit": "PUB_100_02_0001",
"autorenewcyclecnt": "0",
"prodissupportedcredit": "PUB_100_02_0001",
"azName": "az1",
"name": "yc-test1-0013",
"isMaz": "0",
"adminUrl": "http://10.150.66.62:8081/",
"value": "1",
"billmode": "1"
},
"createTime": 1664788881000,
"sfsStatus": 2
}
]
状态码
状态码 | 说明 |
---|---|
200 | 表示请求成功 |
错误码
请参考错误码说明