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

调试

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

请求参数

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

要查询的NAT IP地址列表所属NAT网关实例的地域ID。

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

NatGatewayId String 是 ngw-gw8v16wgvtq26vh59****

要查询NAT IP地址所属NAT网关实例ID。
NatIpCidr String 否 192.168.0.0/24

要查询的NAT IP地址所在的地址段。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会查询NAT IP地址列表。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

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

查询的NAT IP地址的状态。取值：

  • Available：可用状态。
  • Deleting：删除中。
  • Creating：创建中。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883

是否拥有下一次查询的令牌（Token）。取值：

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

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

Action String 是 ListNatIps

系统规定参数。取值：ListNatIps。

NatIpName.N String 否 test

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

NatIpIds.N String 否 vpcnatcidr-gw8ov42ei6xh1jys2****

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

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
RequestId String 7E78CEEA-BF8F-44D1-9DCD-D9141135B71E

请求ID。
TotalCount String 1

查询到的NAT IP地址结果数目。
NatIps Array of NatIp

NAT IP地址列表。
IsDefault Boolean true

是否是默认NAT IP地址。取值：

  • true：是默认NAT IP地址。
  • false：不是默认NAT IP地址。
NatIp String 192.168.0.126

查询的NAT IP地址。
NatIpCidr String 192.168.0.0/24

查询的NAT IP地址所在的地址段。
NatIpId String vpcnatip-gw8a863sut1zijxh0****

查询的NAT IP地址实例ID。
NatIpDescription String default

查询的NAT IP地址的描述信息。
NatGatewayId String ngw-gw8v16wgvtq26vh59****

查询的NAT IP地址所属的VPC NAT网关实例ID。
NatIpName String default

查询的NAT IP地址的名称。
NatIpStatus String Available

查询的NAT IP地址的状态。取值：

  • Available：可用状态。
  • Deleted：已删除。
  • Deleting：删除中。
  • Creating：创建中。
  • Associated：已关联SNAT或DNAT条目。
  • Associating：关联SNAT或DNAT条目中。

示例

请求示例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&NatIpCidr=192.168.0.0/24
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpStatus=Available
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883
&MaxResults=20
&NatIpName=["test"]
&NatIpIds=["vpcnatcidr-gw8ov42ei6xh1jys2****"]
&Action=ListNatIps
&公共请求参数

正常返回示例

XML格式 

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

<ListNatIpsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>7E78CEEA-BF8F-44D1-9DCD-D9141135B71E</RequestId>
    <TotalCount>1</TotalCount>
    <NatIps>
        <IsDefault>true</IsDefault>
        <NatIp>192.168.0.126</NatIp>
        <NatIpCidr>192.168.0.0/24</NatIpCidr>
        <NatIpId>vpcnatip-gw8a863sut1zijxh0****</NatIpId>
        <NatIpDescription>default</NatIpDescription>
        <NatGatewayId>ngw-gw8v16wgvtq26vh59****</NatGatewayId>
        <NatIpName>default</NatIpName>
        <NatIpStatus>Available</NatIpStatus>
    </NatIps>
</ListNatIpsResponse>

JSON格式 

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "7E78CEEA-BF8F-44D1-9DCD-D9141135B71E",
  "TotalCount" : "1",
  "NatIps" : [ {
    "IsDefault" : true,
    "NatIp" : "192.168.0.126",
    "NatIpCidr" : "192.168.0.0/24",
    "NatIpId" : "vpcnatip-gw8a863sut1zijxh0****",
    "NatIpDescription" : "default",
    "NatGatewayId" : "ngw-gw8v16wgvtq26vh59****",
    "NatIpName" : "default",
    "NatIpStatus" : "Available"
  } ]
}

错误码

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

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