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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String eu-central-1

需要查询的NAT IP地址段所属VPC NAT网关的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

NatGatewayId String ngw-gw8v16wgvtq26vh59****

要查询NAT IP地址段的VPC NAT网关的实例ID。

NatIpCidr String 172.16.0.0/24

要查询的NAT IP地址段。

DryRun Boolean false

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询NAT IP地址段列表。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并查询NAT IP地址段列表。
ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
NatIpCidrStatus String Available

要查询的NAT IP地址段的状态。取值:Available,表示可用状态。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults String 20

分批次查询时每次显示的条目数。取值范围:1~100,默认值为20

Action String ListNatIpCidrs

系统规定参数。取值:ListNatIpCidrs

NatIpCidrName.N String cidrname

要查询的NAT IP地址段的名称。N取值为1~20

NatIpCidrs.N String 172.16.0.0/24

要查询的NAT IP地址段。N取值为1~20

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 7479A224-4A28-4895-9604-11F48BCE6A88

请求ID。

TotalCount String 1

查询到的NAT IP地址段的列表条目数。

NatIpCidrs Array of NatIpCidr

NAT IP地址段列表。

CreationTime String 2021-06-28T20:50Z

NAT IP地址段的创建时间。

NatIpCidrId String vpcnatcidr-gw8ov42ei6xh1jys2****

NAT IP地址段实例ID。

IsDefault Boolean true

是否为默认NAT IP地址段。取值:

  • true:是默认NAT IP地址段。
  • false:不是默认NAT IP地址段。
NatIpCidrStatus String Available

NAT IP地址段的状态。取值:Available,表示可用状态。

NatIpCidrName String Name

NAT IP地址段的名称。

NatIpCidr String 172.16.0.0/24

NAT IP地址段。

NatGatewayId String ngw-gw8v16wgvtq26vh59****

NAT IP地址段所属的VPC NAT网关实例ID。

NatIpCidrDescription String test

NAT IP地址段的描述信息。

示例

请求示例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&NatIpCidr=172.16.0.0/24
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpCidrStatus=Available
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=20
&NatIpCidrName=["cidrname"]
&NatIpCidrs=["172.16.0.0/24"]
&Action=ListNatIpCidrs
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNatIpCidrsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>7479A224-4A28-4895-9604-11F48BCE6A88</RequestId>
    <TotalCount>1</TotalCount>
    <NatIpCidrs>
        <CreationTime>2021-06-28T20:50Z</CreationTime>
        <NatIpCidrId>vpcnatcidr-gw8ov42ei6xh1jys2****</NatIpCidrId>
        <IsDefault>true</IsDefault>
        <NatIpCidrStatus>Available</NatIpCidrStatus>
        <NatIpCidrName>default</NatIpCidrName>
        <NatIpCidr>172.16.0.0/24</NatIpCidr>
        <NatGatewayId>ngw-gw8v16wgvtq26vh59****</NatGatewayId>
        <NatIpCidrDescription>default</NatIpCidrDescription>
    </NatIpCidrs>
</ListNatIpCidrsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "default",
    "NatIpCidr" : "172.16.0.0/24",
    "NatGatewayId" : "ngw-gw8v16wgvtq26vh59****",
    "NatIpCidrDescription" : "default"
  } ]
}

错误码

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

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