接口功能介绍
续订 NAT 网关
接口约束
URI
POST /v4/vpc/renew-nat-gateway
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 共享带宽的区域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 |
| cycleCount | Integer | 是 | 订购时长, 当 cycleType = month, 支持续订 1 - 11 个月; 当 cycleType = year, 支持续订 1 - 3 年 | 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 | 资源状态 | unknown |
| masterResourceID | String | 资源id |
请求示例
POST /v4/vpc/renew-nat-gateway
请求体Body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"natGatewayID": "nat-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 | 表示请求成功。 |
错误码
请参考 错误码说明。
