DescribeNatGateways_专有网络_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本接口支持查询公网 NAT 网关或 VPC NAT 网关的详细信息,文中出现的“NAT 网关”不做具体的区分。

流控信息

请求速率为1200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
vpc:DescribeNatGateways
Get
NatGateway
acs:vpc:{#regionId}:{#accountId}:natgateway/*
NatGateway
acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

请求参数

字段名称字段详情
RegionIdstring

要查询的 NAT 网关所在的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
NatGatewayIdstring

要查询的 NAT 网关的 ID。

示例值:ngw-bp1uewa15k4iy5770****参考取值来源:
    CreateNatGateway
VpcIdstring

要查询的 NAT 网关所属 VPC 的 ID。

示例值:vpc-bp15zckdt37pq72z****参考取值来源:
    CreateVpc
Namestring

要查询的 NAT 网关的名称。展开详情

示例值:test
InstanceChargeTypestring

要查询的 NAT 网关实例的付费模式,取值:展开详情

示例值:PostPaid
Specstring

公网 NAT 网关的规格,仅当 InstanceChargeTypePrePaid(存量包年包月公网 NAT 网关)支持按固定规格创建 NAT 网关,取值:展开详情

示例值:中国站示例值:Small,国际站示例值:无需填写
NatTypestring

NAT 网关的类型,取值:Enhanced,增强型。

示例值:Enhanced参考取值来源:
    CreateNatGateway
ResourceGroupIdstring

要查询的 NAT 网关所属的资源组 ID。

示例值:rg-bp67acfmxazb4ph****
PageNumberinteger<int32>

列表的页码,默认值为 1

示例值:10取值 >= 1
PageSizeinteger<int32>

分页查询时每页的行数,最大值为 50,默认值为 10

示例值:1取值 <= 50
DryRunboolean

是否只预检此次请求,取值:展开详情

示例值:false
Statusstring

要查询的 NAT 网关的状态,取值:展开详情

示例值:Available
NetworkTypestring

要查询的 NAT 网关的类型,取值:展开详情

示例值:internet
Tagarray<object>

标签列表。

子级条数 <= 20
ZoneIdstring

NAT 网关所在的可用区 ID。

示例值:cn-hangzhou-b参考取值来源:
    DescribeZones

返回参数

字段名称字段详情
PageSizeinteger<int32>

每页包含的条目数。

示例值:10
RequestIdstring

请求 ID。

示例值:4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumberinteger<int32>

当前页码。

示例值:10
TotalCountinteger<int32>

查询的 NAT 网关列表条目数。

示例值:1
NatGatewaysobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
404
InvalidRegionId.NotFound
The specified RegionId does not exist in our records.诊断
500
InternalError
The request processing has failed due to some unknown error, exception or failure.诊断

变更历史

变更时间变更内容概要操作
2024-10-23
变更返回参数
2024-05-07
删除返回参数
2023-02-28
新增返回参数
2022-12-16
新增错误码500
2022-09-01
变更返回参数
2022-08-26
新增请求参数Tag
变更返回参数
2021-11-17
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例

创建NAT网关
2021-12-01
创建NAT网关并配置SNAT规则
2021-11-30
DNAT规则管理,包括创建、修改、查询、删除
2021-12-17
修改公网NAT网关规格->等待网关规格修改成功
2021-12-23