接口功能介绍
变配私网NAT
接口约束
变配接口只支持资源升级操作
接口是否审批
否
URI
POST /v4/privatenat/modify-spec
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
| 表 body参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|---|
| regionID | 是 | String | 私网NAT网关所在的地域 ID | |||
| natGatewayID | 是 | String | 私网NAT的ID | |||
| spec | 是 | String | 规格(可传值：small, medium, large, xlarge) | |||
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 6 | |||
| payVoucherPrice | 否 | String | 代金券金额，支持到小数点后两位，仅包周期支持代金券 | 1 |
响应参数
| 响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | ||
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | ||
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | ||
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | ||
| returnObj | Object | 返回结果 | returnObj |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | String | 订单 id | 0a82066979eb4869a62861664e4a8171 | ||
| masterOrderNO | String | 订单编号，可以为null | 20221021191602644224 | ||
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求头header示例
无
请求url示例
POST /v4/privatenat/modify-spec
请求体body示例
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"natGatewayID":"31b2500b",
"spec":"medium",
"clientToken":"xxxxxx"
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":"成功",
"returnObj":{
"masterOrderID":"0a82066979eb4869a62861664e4a8171",
"masterOrderNO":"20221021191602644224",
"regionID":"81f7728662dd11ec810800155d307d5b"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
