1)接口功能介绍
创建NAT网关。
2)接口约束
无。
3)URI
POST /v1/createNatGateway。
4)请求参数
请求体body参数
参数 | 是否必须 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘集群id | cn-guangzhou6 | |
vpcId | 是 | String | vpc id,可通过查看vpc信息接口获取(describeVpc) | 209 | |
gatewayName | 是 | String | 网关名称。要求小写字母开头,由小写字母、数字或中划线(-)组成。以小写字母或数字结尾。最大支持64字符。 | myNatGateway-01 | |
description | 是 | String | 网关描述,支持中英文和特殊符号,最大128字符 | 我的第一个NAT网关 | |
serviceDuration | 是 | Duration | 购买服务时长,由”时长值“、”时长单位“两部分组成 | * | serviceDuration |
allocEip | 是 | Boolean | 是否同时购买公网弹性IP | false | |
bandwidthSize | 否 | Integer | 所购买弹性IP的带宽大小,选择购买公网弹性IP时,本参数必填。单位Mbps,取值范围为1~1000 | 40 | |
bandwidthPriceType | 否 | String | 所购买弹性IP的带宽计费方式,选择购买公网弹性IP时,本参数必填。取值范围:按流量计费-TRAFFIC_BILLING。 | TRAFFIC_BILLING |
表 serviceDuration
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
value | 是 | Integer | 购买服务的时长值 | 1 | |
unit | 是 | String | 购买服务的时长单位。w-周,m-月,y-年 | w |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | ||
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
natGatewayId | 是 | String | NAT网关id | 22 |
6)请求示例
请求体body
TRAFFIC_BILLING-按使用流量# 不带公网ip
{
"serviceDuration": {
"unit": "y",
"value": 1
},
"vpcId": "640",
"gatewayName": "nat-test",
"description": "test",
"nodeCode": "yn-baoshan-1",
"allocEip": false
}
带公网ip
{
"vpcId": "640",
"gatewayName": "nat-test2",
"description": "test",
"nodeCode": "yn-baoshan-1",
"allocEip": true,
"bandwidthPriceType": "TRAFFIC_BILLING",
"bandwidthSize": 10,
"serviceDuration": {
"unit": "y",
"value": 1
}
}
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"natGatewayId": "1803"
},
"requestId": "5d7bc462-f738-44da-bf54-eea1493f04ad"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |