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

调试

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

请求参数

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

要执行的操作,取值:ListNatIps

NatGatewayId String ngw-gw8v16wgvtq26vh59****

要查询NAT IP地址所属NAT网关实例ID。

NatIpCidr String 192.168.0.0/24

要查询的NAT IP地址所在的地址段。

RegionId String eu-central-1

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

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

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可能不一样。
NatIpStatus String Available

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

  • Available:可用状态。
  • Deleting:删除中。
  • Creating:创建中。
NextToken String caeba0bbb2be03f84eb48b699f0a4883

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

MaxResults String 20

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

NatIpName.N RepeatList test

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

NatIpIds.N RepeatList vpcnatip-gw8a863sut1zijxh0****

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

返回数据

名称 类型 示例值 描述
NatIps Array of NatIp

NAT IP地址列表。

IsDefault Boolean true

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

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

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

NatIp String 192.168.0.126

查询的NAT IP地址。

NatIpCidr String 192.168.0.0/24

查询的NAT IP地址所在的地址段。

NatIpDescription String default

查询的NAT IP地址的描述信息。

NatIpId String vpcnatip-gw8a863sut1zijxh0****

查询的NAT IP地址实例ID。

NatIpName String default

查询的NAT IP地址的名称。

NatIpStatus String Available

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

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

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

RequestId String 7E78CEEA-BF8F-44D1-9DCD-D9141135B71E

请求ID。

TotalCount String 7

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

示例

请求示例

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

正常返回示例

XML格式

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

JSON格式

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

错误码

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

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