接口功能介绍
续订私网NAT
接口约束
无
接口是否审批
否
URI
POST /v4/privatenat/renew-privatenat
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
| 请求体body参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|---|
| regionID | 是 | String | 私网NAT所在区域的区域id。 | 5A2CFF0E-5718-xxx5-9D4D-70B3FF3898 | ||
| natGatewayID | 是 | String | 私网NAT的ID | nat-dd349df | ||
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | ||
| cycleType | 是 | String | 订购类型：month / year | month | ||
| 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 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | String | 订单id | 4b52382c6b0d11edb33e0242ac110002 | ||
| masterOrderNO | String | 订单编号 | |||
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | ||
| masterResourceStatus | String | 资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知） | started | ||
| masterResourceID | String | 资源id |
枚举参数
无
请求头header示例
无
请求url示例
POST /v4/privatenat/renew-privatenat
请求体body示例
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"natGatewayID":"natgw-dd349df",
"clientToken":"xxxxxx",
"cycleType":"month",
"cycleCount":1
}
响应示例
{
"statusCode":800,
"message":"success",
"description":"",
"errorCode":"SUCCESS",
"returnObj":{
"masterOrderID":"ee508bcc586211ed961bacde48001122",
"masterOrderNO":"20221021191602644224",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterResourceStatus":"unknown",
"masterResourceID":null
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
