接口功能介绍
在指定地域开通一个某种计费模式的网关资源
接口约束
1、该用户需要开通混合存储网关服务
2、开通混合存储网关，会创建某个规格、某种协议的网关资源，该资源为某种计费方式的资源
3、单个用户在指定地域最多可以开通16个网关
URI
POST /v4/nfs/create-nfs-gateway
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID(目前仅支持华东1资源池) | 参考请求示例 | |
| gatewayName | 是 | String | 用户自定义的网关名称，必须大小写字母或中文开头，支持中文，英文大小写，数字，“.”，“_”或“-”，长度不超过50个字符 | 参考请求示例 | |
| protocol | 否 | String | 网关支持的协议，①nfs：nfs协议（目前默认且仅支持nfs协议） | 参考请求示例 | |
| gatewayPosition | 否 | String | 网关部署的位置，①ctyun：天翼云位置（目前默认且仅支持部署在天翼云位置） | 参考请求示例 | |
| gatewayType | 否 | String | 网关的类型，①files：文件网关（目前默认且仅支持文件网关） | 参考请求示例 | |
| gatewaySpec | 否 | String | 网关的规格，①p1：标准版（目前默认且仅支持标准版规格） | 参考请求示例 | |
| gatewayNetType | 否 | String | 网络的方案，①publicnetwork：选用弹性公网；②vpceservice：选用终端节点服务（默认选用弹性公网方案） | 参考请求示例 | |
| netSub | 否 | Integer | 选用弹性公网时为网关公网的带宽，限制5M-200M之间（包含5和200），默认为5M | 5 | |
| netSpec | 否 | String | 选用弹性公网时为公网的规格，①standard：标准版（目前默认且仅支持标准版规格） | 参考请求示例 | |
| onDemand | 是 | Boolean | 是否按需订购，①false：包周期订购（目前仅支持包周期订购网关资源） | false | |
| cycleType | 否 | String | 包周期类型，onDemand 为 false 时必须指定，①MONTH：月（目前仅支持以月为单位创建） | 参考请求示例 | |
| cycleCount | 否 | Integer | 包周期数，onDemand 为 false 时必须指定，周期最大长度不能超过 36个月 | 1 | |
| projectID | 否 | String | 企业项目ID，默认且目前仅支持使用 default 企业项目，其 ID 为 "0" | 参考请求示例 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 响应对象 | 参考表returnObj | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderNO | String | 订单号 | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| masterOrderID | String | 订单ID，调用方在拿到masterOrderID之后，在若干错误情况下，可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"gatewayName":"mingtian",
"regionID":"81f7728662dd11ec810800155d307d5b",
"protocol":"nfs",
"gatewayNetType":"publicnetwork",
"gatewayPosition":"ctyun",
"gatewayType":"files",
"gatewaySpec":"p1",
"netSub":5,
"onDemand":false,
"cycleCount":1,
"cycleType":"MONTH",
"netSpec":"standard"
}
响应示例
{
"description":"订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"returnObj":{
"masterOrderNO":"20240227113845303513",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"6fa8234c78584650a10f9dea31659cb9"
},
"errorCode":"hsg.order.inProgress",
"details":"",
"error":"Hsg.Order.InProgress",
"message":"order in progress",
"statusCode":900
}
状态码
请参考 状态码
错误码
请参考 错误码
