接口功能介绍
创建文件系统
接口约束
- 用户vpc/subnet资源可用
- regionID资源池须支持sfsType类型的弹性文件
- 如若使用isEncrypt加密，用户kmsUUID资源可用，仅支持对称加密类型密钥
- 底层集群剩余可用空间大于sfsSize，sfsSize大小区间为[500GB, 32768GB]
- 用户配额大小默认为50TB
- onDemand 为 false 时必须指定cycleCount。cycleCount周期最大长度不能超过3年
- 资源池信息为"regionVersion": "v4.0"时，新开通的文件系统会自动绑定默认权限组
- 上海7、南京3、成都4等3个资源池仅支持500GB、1TB、2TB、3TB、5TB、10TB、20TB、30TB等固定规格，弹性文件服务支持的资源池请参考产品能力地图。
- 自2024年5月16日起，本接口会受到IAM权限管控，当子账号或委托调用该接口时，需具备“sfs:shares:create”权限。
URI
POST /v4/sfs/new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性；要求单个云平台账户内唯一；参考订单幂等性说明。 | ||
| regionID | 是 | String | 资源池ID；例:100054c0416811e9a6690242ac110002 | ||
| isEncrypt | 否 | Boolean | 是否加密盘，默认false | ||
| kmsUUID | 否 | String | 如果是加密盘，需要提供kms的uuid | ||
| projectID | 否 | String | 企业项目ID,默认为”0” | ||
| sfsType | 否 | String | 弹性文件类型，capacity/performance | ||
| sfsProtocol | 是 | String | 磁盘类型，nfs/cifs/smb,；nfs适用于linux，cifs适用于windows | ||
| name | 是 | String | 命名；单账户单资源池下，命名需唯一 | ||
| sfsSize | 是 | Integer | 大小，单位MB，最小512MB | ||
| onDemand | 否 | Boolean | 是否按需下单；默认为true | ||
| cycleType | 否 | String | 包周期类型，year/month；onDemand为false时，必须指定。 | ||
| cycleCount | 否 | Integer | 包周期数。onDemand为false时必须指定；周期最大长度不能超过3年 | ||
| azName | 否 | String | 多可用区资源池下，必须指定可用区 | ||
| vpc | 是 | String | 虚拟网ID | ||
| subnet | 是 | String | 子网ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| stateCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| msgDesc | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | returnObj | returnObj | |
| msgCode | String | 业务细分码，为product.module.code三段式码；参考结果码 | ||
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的业务相关的错误做明确的错误映射和提升，有唯一对应的msgCode；其他订单侧(bss)的错误，以 sfs.order.102 的msgCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息 | errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态；参考结果码 | ||
| masterOrderNO | String | 订单号 | ||
| masterResourceID | String | 主资源ID。云硬盘场景下，无需关心。 | ||
| masterResourceStatus | String | 主资源状态。参考主资源状态 | ||
| regionID | String | 资源所属资源池ID | ||
| resources | Array of Objects | 资源明细列表,参考资源明细对象 | resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 单项资源的变配、续订、退订等需要该资源项的ID；比如某个云主机资源作为主资源，对其挂载 | ||
| resourceType | String | 资源类型 | ||
| orderID | String | 无需关心 | ||
| startTime | Long | 启动时刻，epoch 时戳，毫秒精度。例：1589869069561 | ||
| createTime | Long | 创建时刻，epoch 时戳，毫秒精度 | ||
| updateTime | Long | 更新时刻，epoch 时戳，毫秒精度 | ||
| status | Integer | 资源状态 | ||
| isMaster | Boolean | 是否是主资源项 | ||
| itemValue | Integer | 无需关心 | ||
| UID | String | 弹性文件系统内部唯一 ID | ||
| sfsStatus | Integer | 弹性文件状态序号 | ||
| masterOrderID | String | 订单 ID | ||
| name | String | 弹性文件名字 | ||
| masterResourceID | String | 主资源 ID | ||
| resourceConfig | Object | 资源开通相关信息，无需关心 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体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
}
]
状态码
请参考 状态码
错误码
请参考 错误码
