本接口用于获取NAT边界防火墙的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Lang |
string |
否 |
返回消息的语言类型。取值：
|
zh |
| Lang |
string |
否 |
返回消息的语言类型。取值：
|
zh |
| PageNo |
integer |
否 |
当前页面的页码。 |
1 |
| PageSize |
integer |
否 |
分页查询时，设置每页包含 NAT 边界防火墙的数量。 默认值为 10，表示每页包含 10 条结果。最大值为 50。 |
10 |
| ProxyId |
string |
否 |
NAT 防火墙 ID。 |
proxy-nat97a****** |
| ProxyName |
string |
否 |
NAT 防火墙名称。支持大小写英文字母、中文、数字、下划线（_）、长度为[4,50]个字符,且不能以下划线开头。 |
nat-防火墙测试 |
| RegionNo |
string |
否 |
VPC 所在的地域 ID。 说明
关于云防火墙支持地域的详细信息，请参见支持的地域。 |
cn-hangzhou |
| VpcId |
string |
否 |
VPC 实例 ID。 |
vpc-8vbwbo90rq0anm6t**** |
| NatGatewayId |
string |
否 |
NAT 网关的 ID。 |
ngw-bp123456g****** |
| Status |
string |
否 |
云防火墙状态。取值：
|
normal |
| MemberUid |
integer |
否 |
当前阿里云账号的成员账号 UID。 |
147783****** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalCount |
integer |
NAT 边界防火墙的总数量。 |
10 |
| RequestId |
string |
返回结果的请求 ID。 |
15FCCC52-1E23-57AE-B5EF-3E00A3****** |
| NatFirewallList |
array<object> |
云防火墙列表 |
|
|
array<object> |
云防火墙列表 |
||
| MemberUid |
integer |
云防火墙成员账号的 UID。 |
19106481****** |
| AliUid |
integer |
阿里云账号的 UID。 说明
云防火墙成员账号的主账号。 |
19106481****** |
| ProxyId |
string |
NAT 防火墙 ID。 |
proxy-nat30****** |
| ProxyName |
string |
NAT 防火墙名称。 |
nat-防火墙测试 |
| ProxyStatus |
string |
云防火墙状态。取值：
|
normal |
| RegionId |
string |
云防火墙所在的地域 ID。 说明
关于云防火墙支持地域的详细信息，请参见支持的地域。 |
cn-qingdao |
| NatGatewayId |
string |
要查询的 NAT 网关的 ID。 |
ngw-uf6tnblxip4qcxg****** |
| NatGatewayName |
string |
NAT 网关的名称 |
NAT网关测试 |
| VpcId |
string |
VPC 实例 ID。 |
vpc-2ze26ya****** |
| VpcName |
string |
VPC 的实例名称。 |
vpc-测试实例 |
| ErrorDetail |
string |
错误原因。 |
防火墙创建失败 |
| StrictMode |
integer |
是否启用严格模式
|
0 |
| NatRouteEntryList |
array<object> |
NAT 网关默认路由条目列表。 |
|
|
object |
NAT 网关默认路由条目。 |
||
| RouteTableId |
string |
NAT 网关默认路由所在路由表。 |
vtb-bp18o0gb****** |
| NextHopId |
string |
原 NAT 网关下一跳转地址。 |
ngw-2ze0s284r9atg5****** |
| NextHopType |
string |
下一跳的网络类型。取值：NatGateway。 |
NatGateway |
| DestinationCidr |
string |
默认路由目的网段。 |
0.0.0.0/0 |
| ProxyVSwitchId |
string |
防火墙使用的交换机 ID。 |
vsw-bp1amn3t1ktjjy8****** |
| ProxyRouteTableId |
string |
防火墙使用的路由表 ID。 |
vtb-bp1pmyga7p4j10a****** |
| ProxyNetworkInterfaceId |
string |
防火墙使用的弹性网卡 ID。 |
eni-bp127llmo4v5qju****** |
示例
正常返回示例
JSON格式
{
"TotalCount": 10,
"RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******\n",
"NatFirewallList": [
{
"MemberUid": 0,
"AliUid": 0,
"ProxyId": "proxy-nat30******",
"ProxyName": "nat-防火墙测试\n",
"ProxyStatus": "normal",
"RegionId": "cn-qingdao",
"NatGatewayId": "ngw-uf6tnblxip4qcxg******",
"NatGatewayName": "NAT网关测试\n",
"VpcId": "vpc-2ze26ya******",
"VpcName": "vpc-测试实例",
"ErrorDetail": "防火墙创建失败",
"StrictMode": 0,
"NatRouteEntryList": [
{
"RouteTableId": "vtb-bp18o0gb******",
"NextHopId": "ngw-2ze0s284r9atg5******",
"NextHopType": "NatGateway",
"DestinationCidr": "0.0.0.0/0"
}
],
"ProxyVSwitchId": "vsw-bp1amn3t1ktjjy8******",
"ProxyRouteTableId": "vtb-bp1pmyga7p4j10a******",
"ProxyNetworkInterfaceId": "eni-bp127llmo4v5qju******"
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | aliuid无效 |
| 400 | ErrorPageNo | Either page number or page size is invalid. | 无效的page number 或者 page size |
| 400 | ErrorDBSelectError | A database select error occurred. | 内部错误：数据库查询错误 |
| 400 | ErrorNatGatewayNotAvailable | Nat gateway not available. | NAT网关状态不可用, 不能操作。 |
| 400 | ErrorDnatNotSupport | NAT firewall does not support DAT entries. | NAT防火墙不支持DNAT。 |
| 400 | ErrorProxySnatIpEmpty | SNAT entry is empty. | SNAT条目为空。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。