接口功能介绍

弹性文件开通

接口约束

用户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年10月15日起，本接口会受到IAM权限管控，当子账号或委托调用该接口时，需具备“sfs:shares:create”权限，否则会报权限不足的错误

URI

POST /v4/sfs/new-sfs

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
clientToken	否	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一	参考[请求示例]
regionID	是	String	资源池 ID，例：100054c0416811e9a6690242ac110002	参考[请求示例]
isEncrypt	否	Boolean	是否加密盘，true/false，默认 false	true
kmsUUID	否	String	如果是加密盘，需要提供 kms 的 uuid	参考[请求示例]
projectID	否	String	资源所属企业项目 ID，默认为'0'	参考[请求示例]
sfsType	是	String	弹性文件类型，capacity/performance	参考[请求示例]
sfsProtocol	是	String	协议类型，nfs/cifs/nfs,cifs三种类型, nfs 适用于 linux，cifs 适用于 windows；cifs 适用于 windows；nfs,cifs可以挂载至linux和windows，仅部分"regionVersion": "v3.0"的资源池适用。	参考[请求示例]
sfsName	是	String	弹性文件名。单账户单资源池下，命名需唯一	参考[请求示例]
sfsSize	是	Integer	大小，单位 GB，最小 500GB	500
onDemand	否	Boolean	是否按需下单。true/false，默认为 true	true
cycleType	否	String	包周期（subscription）类型，year/month。onDemand 为 false 时，必须指定	参考[请求示例]
cycleCount	否	Integer	包周期数。onDemand 为 false 时必须指定。周期最大长度不能超过 3 年	3
azName	否	String	多可用区资源池下，必须指定可用区。4.0资源池必填	参考[请求示例]
vpc	是	String	虚拟网 ID	参考[请求示例]
subnet	是	String	子网 ID	参考[请求示例]

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败/订单处理中)	800
message	String	响应描述，一般为英文描述	参考[结果码]
description	String	响应描述，一般为中文描述	参考[结果码]
returnObj	Object	参考[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 Objects	资源明细		resources

表 resources

参数	参数类型	说明	示例
resourceID	String	单项资源的变配、续订、退订等需要该资源项的 ID。比如某个云主机资源作为主资源，对其挂载	参考[响应示例]
resourceType	String	资源类型。SFS_TURBO/SFS_TURBOC	参考[响应示例]
orderID	String	无需关心	参考[响应示例]
startTime	Long	启动时刻，epoch 时戳，毫秒精度。例：1589869069561	1678863483000
createTime	Long	创建时刻，epoch 时戳，毫秒精度	1678863483000
updateTime	Long	更新时刻，epoch 时戳，毫秒精度	1678863483000
status	Integer	资源状态，无需关心。	2
isMaster	Boolean	是否是主资源项	true
itemValue	Integer	无需关心	1
sfsUID	String	弹性文件系统内部唯一 ID	参考[响应示例]
sfsStatus	String	弹性文件状态。available/unusable	参考[响应示例]
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

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
  "azName": "az1",
  "subnet": "subnet-32m8794aev",
  "vpc": "vpc-2ophm4xirb",
  "sfsProtocol": "nfs",
  "sfsSize": 512,
  "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
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性文件服务

弹性文件服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性文件服务

弹性文件服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码