全部产品
Search
文档中心

云防火墙:DescribeNatFirewallList - 查询NAT防火墙

更新时间:Sep 03, 2024

本接口用于获取NAT边界防火墙的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:DescribeNatFirewallListget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Langstring

返回消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
zh
PageNolong

当前页面的页码。

1
PageSizelong

分页查询时,设置每页包含 NAT 边界防火墙的数量。

默认值为 10,表示每页包含 10 条结果。最大值为 50

10
ProxyIdstring

NAT 防火墙 ID。

proxy-nat97a******
ProxyNamestring

NAT 防火墙名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符,且不能以下划线开头。

nat-防火墙测试
RegionNostring

VPC 所在的地域 ID。

说明 关于云防火墙支持地域的详细信息,请参见支持的地域
cn-hangzhou
VpcIdstring

VPC 实例 ID。

vpc-8vbwbo90rq0anm6t****
NatGatewayIdstring

NAT 网关的 ID。

nat-bp123456g******
Statusstring

云防火墙状态。取值:

  • configuring:创建中
  • deleting:删除中
  • normal:正常
  • abnormal:异常
  • opening:开启中
  • closing:关闭中
  • closed:已关闭
normal
MemberUidlong

当前阿里云账号的成员账号 UID。

147783******

返回参数

名称类型描述示例值
object
TotalCountinteger

NAT 边界防火墙的总数量。

10
RequestIdstring

返回结果的请求 ID。

15FCCC52-1E23-57AE-B5EF-3E00A3******
NatFirewallListarray<object>

云防火墙列表

object

云防火墙列表

MemberUidlong

云防火墙成员账号的 UID。

19106481******
AliUidlong

阿里云账号的 UID。

说明 云防火墙成员账号的主账号。
19106481******
ProxyIdstring

NAT 防火墙 ID。

proxy-nat30******
ProxyNamestring

NAT 防火墙名称。

nat-防火墙测试
ProxyStatusstring

云防火墙状态。取值:

  • configuring:创建中
  • deleting:删除中
  • normal:正常
  • abnormal:异常
  • opening:开启中
  • closing:关闭中
  • closed:已关闭
normal
RegionIdstring

云防火墙所在的地域 ID。

说明 关于云防火墙支持地域的详细信息,请参见支持的地域
cn-qingdao
NatGatewayIdstring

要查询的 NAT 网关的 ID。

ngw-uf6tnblxip4qcxg******
NatGatewayNamestring

NAT 网关的名称

NAT网关测试
VpcIdstring

VPC 实例 ID。

vpc-2ze26ya******
VpcNamestring

VPC 的实例名称。

vpc-测试实例
ErrorDetailstring

错误原因。

防火墙创建失败
StrictModeinteger

是否启用严格模式

  • 1:启用严格模式
  • 0:禁用严格模式
0
NatRouteEntryListarray<object>

NAT 网关默认路由条目列表。

object

NAT 网关默认路由条目。

RouteTableIdstring

NAT 网关默认路由所在路由表。

vtb-bp18o0gb******
NextHopIdstring

原 NAT 网关下一跳转地址。

ngw-2ze0s284r9atg5******
NextHopTypestring

下一跳的网络类型。取值:NatGateway。

NatGateway
DestinationCidrstring

默认路由目的网段。

0.0.0.0/0

示例

正常返回示例

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"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorAliUidAliuid invalid.aliuid无效
400ErrorPageNoEither page number or page size is invalid.无效的page number 或者 page size
400ErrorDBSelectErrorA database select error occurred.内部错误:数据库查询错误
400ErrorNatGatewayNotAvailableNat gateway not available.NAT网关状态不可用, 不能操作。
400ErrorDnatNotSupportNAT firewall does not support DAT entries.NAT防火墙不支持DNAT。
400ErrorProxySnatIpEmptySNAT entry is empty.SNAT条目为空。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-27OpenAPI 返回结构发生变更查看变更详情