接口介绍
创建并行文件系统
接口约束
- 用户vpc/subnet资源可用
- regionID资源池支持sfsType类型的并行文件
- 底层集群剩余可用空间大于sfsSize,sfsSize大小区间为[512GB, 1048576GB]
- 用户配额大小默认为50TB
- 目前只支持按需下单
- 新开通的文件系统会自动绑定默认权限组
URI
POST /v4/hpfs/new-sfs
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 |
regionID | 是 | String | 资源池 ID,例:100054c0416811e9a6690242ac110002 | 参考请求示例 |
projectID | 否 | String | 资源所属企业项目 ID,默认为"0" | 参考请求示例 |
sfsType | 是 | String | 并行文件类型,hpfs_perf(HPC性能型) | 参考请求示例 |
sfsProtocol | 是 | String | 协议类型,nfs/hpfs | 参考请求示例 |
onDemand | 否 | Boolean | 是否按需下单。true/false,默认为 true | 参考请求示例 |
cycleType | 否 | String | 包周期(subscription)类型,year/month。onDemand 为 false 时,必须指定 | 参考请求示例 |
cycleCount | 否 | Integer | 包周期数。onDemand 为 false 时必须指定。周期最大长度不能超过 3 年 | 参考请求示例 |
sfsName | 是 | String | 并行文件名。单账户单资源池下,命名需唯一 | 参考请求示例 |
sfsSize | 是 | Integer | 大小,单位 GB, 起始容量512,步长为512 | 参考请求示例 |
azName | 否 | String | 多可用区资源池下,必须指定可用区。如不指定则在数据库中自动匹配 | 参考请求示例 |
vpc | 是 | String | 虚拟网 ID | 参考请求示例 |
subnet | 是 | String | 子网 ID | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为处理中/失败,详见errorCode) | 800 |
message | 是 | String | 响应描述 | 参考结果码 |
description | 是 | String | 响应描述 | 参考结果码 |
returnObj | 是 | Object | returnObj | 参考returnObj |
errorCode | 是 | String | 业务细分码,为 product.module.code 三段式码,参考结果码 | 参考结果码 |
errorDetail | 是 | Object | 错误明细。一般情况下,会对订单侧(bss)的并行文件订单业务相关的错误做明确的错误映射和提升,有唯一对应的errorCode。其他订单侧(bss)的错误,以sfs.order.procFailed的errorCode统一映射返回,并在errorDetail中返回订单侧的详细错误信息 | 参考errorDetail |
error | 是 | String | 业务细分码,为product.module.code三段式大驼峰码。 | 参考通用结果码(大驼峰形式) |
returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
masterOrderID | 否 | String | 订单 ID。调用方在拿到 masterOrderID 之后,在若干错误情况下,可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 |
masterOrderNO | 否 | String | 订单号 | 参考响应示例 |
masterResourceID | 否 | String | 主资源 ID | 参考响应示例 |
masterResourceStatus | 否 | String | 主资源状态。 | 参考响应示例 |
regionID | 否 | String | 资源所属资源池 ID | 参考响应示例 |
resources | 否 | Array of Objects | 资源明细 | 参考响应示例 |
resources
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
resourceID | 否 | String | 单项资源的变配、续订、退订等需要该资源项的 ID。比如某个云主机资源作为主资源,对其挂载 | 参考响应示例 |
resourceType | 否 | String | 资源类型 | 参考响应示例 |
orderID | 否 | String | 无需关心 | 参考响应示例 |
startTime | 否 | Integer | 启动时刻,epoch 时戳,毫秒精度。例:1589869069561 | 参考响应示例 |
createTime | 否 | Integer | 创建时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
updateTime | 否 | Integer | 更新时刻,epoch 时戳,毫秒精度 | 参考响应示例 |
status | 否 | Integer | 资源状态 | 参考响应示例 |
isMaster | 否 | Boolean | 是否是主资源项 | 参考响应示例 |
itemValue | 否 | Integer | 无需关心 | 参考响应示例 |
sfsUID | 否 | String | 并行文件系统内部唯一 ID | 参考响应示例 |
sfsStatus | 否 | String | 并行文件状态 | 参考响应示例 |
masterOrderID | 否 | String | 订单 ID | 参考响应示例 |
sfsName | 否 | String | 并行文件名字 | 参考响应示例 |
masterResourceID | 否 | String | 主资源 ID | 参考响应示例 |
errorDetail
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
bssErrCode | 是 | String | bss错误明细码,包含于bss格式化JSON错误信息中 | code_foo |
bssErrMsg | 是 | String | bss错误信息,包含于bss格式化JSON错误信息中 | error_foo |
bssOrigErr | 否 | String | 无法明确解码bss错误信息时,原样透出的bss错误信息 | unknow_error |
bssErrPrefixHint | 否 | String | bss格式化JSON错误信息的前置提示信息 | error_bar |
请求示例
请求头
无
请求体 body
{
"subnet": "subnet-g5t9dg9tbr",
"vpc": "vpc-93gwgagqxd",
"onDemand": true,
"sfsType": "hpfs_perf",
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsSize": 512,
"sfsProtocol": "nfs",
"azName": "az2",
"clientToken": "test-new-hpfs-2023-0719-0003-token",
"sfsName": "hpfs-2023-0711-16092"
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "b50beb2a3cd411eea5db0242ac11001b",
"masterResourceID": "0142042f3c004d81a5cd4ed237cd0327",
"masterOrderNO": null,
"resources": [
{
"orderID": "e87b130883e94a96918eef7a4b555de0",
"status": 2,
"isMaster": true,
"sfsStatus": "available",
"resourceType": "HPFS",
"resourceID": "0142042f3c004d81a5cd4ed237cd0327",
"masterOrderID": "b50beb2a3cd411eea5db0242ac11001b",
"updateTime": 1692259504000,
"masterResourceID": "0142042f3c004d81a5cd4ed237cd0327",
"itemValue": 512,
"startTime": 1692259495000,
"sfsName": "hpfs-2023-0711-16092",
"createTime": 1692259479000,
"sfsUID": "a2d4b927-9511-5a9b-b1de-cfe55779c1ea"
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 说明 |
---|---|
800 | 表示请求成功 |
错误码
请参考错误码