文档中心

NAT网关 API参考手册

最近更新时间：2023-04-16 17:00:00

1 NAT 网关

1.1 CreateNAT

创建 NAT 网关实例。

1.1.1 使用说明

POST https://{Endpoint}/nat/v1.0/natgateways

1.1.2 请求参数

表1-1 header 中请求参数（说明：经过网关调用接口时不需要传入此表参数。）

表1-2 body 请求参数

1.1.3 响应参数

表1-3 响应参数

表1-4 FindEipBind

1.1.4 示例

1. 请求示例

POST /v1.0/natgateways

{

"VpcId": "vpc-50rs4oa91y",

"Specification": "1",

"Name": "nat-open",

"RegionCode": "hanmei03",

"Duration": 1,

"PeriodType": "year"

}

2. 正常返回示例

{

"RequestId": "f81f0fbe9fdacb76902e4191a17e49e4",

"Id": "natgw-thrc7dlog850",

"Name": "nat-open",

"Description": "",

"TenantId": "220002061700520",

"VpcId": "vpc-50rs4oa91y",

"Specification": "1",

"Status": "RUNNING",

"SnatCount": 0,

"DnatCount": 0,

"Eips": null,

"AdminStateUp": true,

"CreatedAt": "2022-03-07T15:44:11.927+08:00",

"UpdatedAt": "2022-03-07T15:44:11.926814062+08:00"

}

1.2 DeleteNAT

删除 NAT 网关实例。

1.2.1 使用说明

DELETE https://{Endpoint}/nat/v1.0/natgateways/{nat_gateway_id}

1.2.2 请求参数

表1-5 query 参数说明

1.2.3 响应参数

无。

1.2.4 示例

1. 请求样例

GET https://{Endpoint}/nat/v1.0/natgateways/a02e93dfc361b32d

2. 正常返回示例

{

"RequestId": "f81f0fbe9fdacb76902e4191a17e49e4",

"Id": "natgw-thrc7dlog850",

}

1.3 GetNATDetail

查询指定 NAT 网关实例详情。

1.3.1 使用说明

GET https://{Endpoint}/nat/v1.0/natgateways/{nat_gateway_id}

1.3.2 请求参数

表1-6 query 参数说明

1.3.3 响应参数

表1-7 响应参数

表1-8 eips 参数说明

1.3.4 示例

1.3.4.1 请求样例

GET /v1.0/natgateways/a02e93dfc361b32d

1.3.4.2 响应样例

{

"id": "a02e93dfc361b32d",

"name": "nat-gateway-1",

"tenant_id": "t1",

"description" : "",

"vpc_id" : "c2uv8g1d8rfrd8q88brg",

"subnet_id" : "bsudhjcbknaoiwefdssa",

"port_id" : "port-123bhwsad",

"specification" : "1",

"status" : "CREATING",

"admin_state_up" : true,

"snat_count" : 1,

"dnat_count" : 2,

"eips" : [

{

"id" : "eip-sdad",

"address" : "10.255.0.1"

{

"id" : "eip-adkuij",

"address" : "10.255.0.2"

"created_at":"2019-01-19T05:32:56",

"updated_at":"2019-01-19T05:32:57"

}

1.4 GetNATList

查询 NAT 网关实例列表。

1.4.1 使用说明

GET https://{Endpoint}/nat/v1.0/natgateways

1.4.2 请求参数

无。

1.4.3 响应参数

表1-9 响应参数

表1-10 NAT 网关对象

表1-11 eips 参数说明

1.4.4 示例

1. 请求样例

GET https://{Endpoint}/nat/v1.0/natgateways

2. 响应样例

{

"RequestId": "6214e9c197a0a61dfc0c2fa92e88a54d",

"PageNumber": 0,

"PageSize": 0,

"TotalCount": 3,

"NatGws": [

{

"RequestId": "",

"Id": "natgw-f5iig7klixgr",

"Name": "nat-open",

"Description": "",

"TenantId": "220002061700520",

"VpcId": "vpc-8zkd82peeh",

"Specification": "1",

"Status": "RUNNING",

"SnatCount": 0,

"DnatCount": 0,

"Eips": null,

"AdminStateUp": true,

"CreatedAt": "2022-03-01T12:04:48+08:00",

"UpdatedAt": "2022-03-01T12:04:48+08:00"

{

"RequestId": "",

"Id": "natgw-ztxltjb9af7l",

"Name": "update-name",

"Description": "",

"TenantId": "220002061700520",

"VpcId": "vpc-zmqkdclskn",

"Specification": "1",

"Status": "RUNNING",

"SnatCount": 0,

"DnatCount": 0,

"Eips": [

{

"EipId": "eip-y8gh5ep2ohav",

"Address": "10.255.10.81"

}

"AdminStateUp": true,

"CreatedAt": "2022-03-01T16:54:25+08:00",

"UpdatedAt": "2022-03-02T10:33:58+08:00"

{

"RequestId": "",

"Id": "natgw-thrc7dlog850",

"Name": "nat-open",

"Description": "",

"TenantId": "220002061700520",

"VpcId": "vpc-50rs4oa91y",

"Specification": "1",

"Status": "RUNNING",

"SnatCount": 0,

"DnatCount": 0,

"Eips": null,

"AdminStateUp": true,

"CreatedAt": "2022-03-07T15:44:12+08:00",

"UpdatedAt": "2022-03-07T15:44:12+08:00"

}

]

}

1.5 RenameNAT

修改 NAT 网关的名称。

1.5.1 使用说明

PUT https://{Endpoint}/nat/v1.0/natgateways/{nat_gateway_id}

1.5.2 请求参数

表1-12 query 参数说明

表1-13 body 请求参数

1.5.3 响应参数

表1-14 响应参数

1.5.4 示例

1.5.4.1 请求样例

PUT http://{Endpoint}/nat/v1.0/natgateways/a02e93dfc361b32d

{

"name":"nat-gateway-1"

}

1.5.4.2 响应样例

{

"RequestId":"sdadasdsfa",

"Id":"nat-dadasdad"

}

1.6 RenewNAT

续费 NAT 网关实例。

1.6.1 使用说明

POST https://{Endpoint}/nat/v1.0/natgateways/renew

1.6.2 请求参数

表1-15 body 请求参数

1.6.3 响应参数

表1-16 响应参数

1.6.4 示例

1. 请求样例

POST http://{Endpoint}/nat/v1.0/natgateways/renew

{

"NatId": "natgw-thrc7dlog850",

"Duration": 1,

"PeriodType": "year"

}

2. 响应样例

{

"RequestId":"sdadasdsfa",

"Id":"nat-dadasdad"

}

1.7 BindEIP

绑定 EIP 到 NAT 网关实例。

1.7.1 使用说明

POST https://{Endpoint}/nat/v1.0/natgateways/eipbind

1.7.2 请求参数

表1-17 body 请求参数

1.7.3 响应参数

表1-18 响应参数

1.7.4 示例

1. 请求样例

POST http://{Endpoint}/natgateways/eipbind

{

"EipId": "eip-2zjiv09scel6",

"NatId": "natgw-fr9p5aeheqgq"

}

2. 响应样例

{

"RequestId":"sdadasdsfa",

"Id":"nat-dadasdad"

}

1.8 UnbindEIP

从 NAT 网关实例解绑 EIP。

1.8.1 使用说明

POST https://{Endpoint}/nat/v1.0/natgateways/eipunbind

1.8.2 请求参数

表1-19 body 请求参数

1.8.3 响应参数

表1-20 响应参数

1.8.4 示例

1. 请求样例

POST http://{Endpoint}/nat/v1.0/natgateways/eipunbind

{

"EipId": "eip-2zjiv09scel6",

"NatId": "natgw-fr9p5aeheqgq"

}

2. 响应样例

{

"RequestId":"sdadasdsfa",

"Id":"natgw-fr9p5aeheqgq"

}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服