接口介绍
创建文件系统
接口约束
- 用户vpc/subnet资源可用
- regionID资源池须支持sfsType类型的海量文件
- 底层集群剩余可用空间大于sfsSize，sfsSize大小区间为[100GB, 1PB]
- 用户配额大小默认为500TB
- onDemand为false 时必须指定cycleCount。cycleCount周期最大长度不能超过3年
- 资源池信息为"regionVersion": "v4.0"时，新开通的文件系统会自动绑定默认权限组
URI
POST /v4/oceanfs/new-sfs
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考响应示例 | |
| regionID | 是 | String | 资源池 ID，例：100054c0416811e9a6690242ac110002 | 参考响应示例 | |
| projectID | 否 | String | 资源所属企业项目 ID，默认为"0" | 参考响应示例 | |
| sfsType | 是 | String | 海量文件类型massive | 参考响应示例 | |
| sfsProtocol | 是 | String | 协议类型，nfs/cifs, nfs 适用于 linux，cifs 适用于 windows | 参考响应示例 | |
| sfsName | 是 | String | 海量文件系统实例名称。单账户单资源池下，命名需唯一 | 参考响应示例 | |
| sfsSize | 是 | Integer | 大小，单位 GB，sfsSize大小区间为[100GB, 1PB] | 参考响应示例 | |
| 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三段式码大驼峰形式 | 参考结果码 |
表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 | 资源类型。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 | 海量文件状态（available） | 参考响应示例 |
| 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": "OceanFS",
"resourceID": "4f0c85264fdc4f16b17265578decfa3c",
"masterOrderID": "8722c040c2fd11edaca10242ac110006",
"updateTime": 1678863487000,
"masterResourceID": "4f0c85264fdc4f16b17265578decfa3c",
"itemValue": 500,
"startTime": 1678863483000,
"resourceConfig": {
"subnet": "subnet-32m8794aev",
"protocol": "nfs",
"name": "sfs-2023-0314-1658",
"adminUrl": "http://admin.huidu.inner.cn:38081/",
"projectID": "0",
"spec": "500",
"regionid": "699bdf69d27e4e2ab5dffb38abefb11c",
"volumetype": "nvme",
"number": "500",
"value": "500",
"prodissupportedcredit": "PUB_100_02_0001",
"azName": "az1",
"isEncrypted": "False",
"vpc": "vpc-2ophm4xirb",
"billmode": "2",
"zonetype": "1",
"zoneid": "699bdf69d27e4e2ab5dffb38abefb11c",
"version": "v1",
"size": "500"
},
"sfsName": "sfs-2023-0314-1658",
"createTime": 1678862971000,
"sfsUID": "68209584-b16b-5df2-b028-7f86c99a1bab"
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 说明 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考错误码说明
