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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListNatIpCidrs

要执行的操作,取值:ListNatIpCidrs

RegionId String eu-central-1

要查询的NAT IP地址段所属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(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并查询NAT IP地址段列表。
ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

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

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

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

MaxResults String 20

分页大小,取值范围:10~100,默认为20

NatIpCidrName.N RepeatList test

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

NatIpCidrs.N RepeatList 172.16.0.0/24

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

返回数据

名称 类型 示例值 描述
NatIpCidrs Array of NatIpCidr

NAT IP地址段列表。

CreationTime String 2021-06-28T20:50Z

NAT IP地址段的创建时间。

IsDefault Boolean true

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

  • true:是默认NAT IP地址段。
  • false:不是默认NAT IP地址段。
NatGatewayId String ngw-gw8v16wgvtq26vh59****

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

NatIpCidr String 172.16.0.0/24

NAT IP地址段。

NatIpCidrDescription String default

NAT IP地址段的描述信息。

NatIpCidrId String vpcnatcidr-gw8ov42ei6xh1jys2****

NAT IP地址段实例ID。

NatIpCidrName String default

NAT IP地址段的名称。

NatIpCidrStatus String Available

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

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

RequestId String 7479A224-4A28-4895-9604-11F48BCE6A88

请求ID。

TotalCount String 1

查询到的NAT IP地址段结果数目。

示例

请求示例

http(s)://[Endpoint]/?Action=ListNatIpCidrs
&RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&NatIpCidr=172.16.0.0/24
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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

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