调用CidrListNatIpCidrs-查询NAT IP地址段列表_NAT网关(NAT Gateway)-阿里云帮助中心

调用ListNatIpCidrs接口查询NAT IP地址段列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	需要查询的 NAT IP 地址段所属 VPC NAT 网关的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	eu-central-1
NatGatewayId	string	是	要查询 NAT IP 地址段的 VPC NAT 网关的实例 ID。	ngw-gw8v16wgvtq26vh59****
NatIpCidr	string	否	要查询的 NAT IP 地址段。	172.16.0.0/24
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会查询 NAT IP 地址段列表。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码 DryRunOperation。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并查询 NAT IP 地址段列表。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidrStatus	string	否	要查询的 NAT IP 地址段的状态。取值：Available，表示可用状态。	Available
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	string	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	20
NatIpCidrName	array	否	要查询的 NAT IP 地址段的名称。N 取值为 1~20。
	string	否	要查询的 NAT IP 地址段的名称。N 取值为 1~20。	cidrname
NatIpCidrs	array	否	要查询的 NAT IP 地址段。N 取值为 1~20。
	string	否	要查询的 NAT IP 地址段。N 取值为 1~20。	172.16.0.0/24

返回参数

名称	类型	描述	示例值
	object
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	7479A224-4A28-4895-9604-11F48BCE6A88
TotalCount	string	查询到的 NAT IP 地址段的列表条目数。	1
NatIpCidrs	array<object>	NAT IP 地址段列表。
NatIpCidr	object	NAT IP 地址段列表。
CreationTime	string	NAT IP 地址段的创建时间。	2021-06-28T20:50Z
NatIpCidrId	string	NAT IP 地址段实例 ID。	vpcnatcidr-gw8ov42ei6xh1jys2****
IsDefault	boolean	是否为默认 NAT IP 地址段。取值： true：是默认 NAT IP 地址段。 false：不是默认 NAT IP 地址段。	true
NatIpCidrStatus	string	NAT IP 地址段的状态。取值：Available，表示可用状态。	Available
NatIpCidrName	string	NAT IP 地址段的名称。	Name
NatIpCidr	string	NAT IP 地址段。	172.16.0.0/24
NatGatewayId	string	NAT IP 地址段所属的 VPC NAT 网关实例 ID。	ngw-gw8v16wgvtq26vh59****
NatIpCidrDescription	string	NAT IP 地址段的描述信息。	test

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "7479A224-4A28-4895-9604-11F48BCE6A88",
  "TotalCount": "1",
  "NatIpCidrs": [
    {
      "CreationTime": "2021-06-28T20:50Z",
      "NatIpCidrId": "vpcnatcidr-gw8ov42ei6xh1jys2****",
      "IsDefault": true,
      "NatIpCidrStatus": "Available",
      "NatIpCidrName": "Name",
      "NatIpCidr": "172.16.0.0/24",
      "NatGatewayId": "ngw-gw8v16wgvtq26vh59****",
      "NatIpCidrDescription": "test"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。

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

变更历史

变更时间	变更内容概要	操作
2024-07-23	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-03-01	OpenAPI 错误码发生变更	查看变更详情