ListNatIpCidrs - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries NAT CIDR blocks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Virtual Private Cloud (VPC) NAT gateway that you want to query. You can call the DescribeRegions operation to query the most recent region list.	eu-central-1
NatGatewayId	string	Yes	The ID of the VPC NAT gateway that you want to query.	ngw-gw8v16wgvtq26vh59****
NatIpCidr	string	No	The CIDR block of the NAT gateway that you want to query.	172.16.0.0/24
DryRun	boolean	No	Specifies whether to only precheck this request. Valid values: true: checks the API request. The CIDR blocks of the NAT gateway are not queried if the API request passes the precheck. The system checks whether your AccessKey pair is valid, whether the Resource Access Management (RAM) user is authorized, and whether the required parameters are set. If the request fails to pass the precheck, the corresponding error message is returned. If the check succeeds, the DryRunOperation error code is returned. false: sends the API request. If the request passes the precheck, 2xx HTTP status code is returned and the CIDR blocks of the NAT gateway are queried. This is the default value.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidrStatus	string	No	The status of the CIDR block that you want to query. Set the value to Available.	Available
NextToken	string	No	The token that is used for the next query. Set the value as needed. If this is your first query or no next query is to be sent, ignore this parameter. If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	string	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
NatIpCidrName	array	No	The name of the CIDR block that you want to query. Valid values of N: 1 to 20.
	string	No	The name of the CIDR block that you want to query. Valid values of N: 1 to 20.	cidrname
NatIpCidrs	array	No	The CIDR block of the NAT gateway that you want to query. Valid values of N: 1 to 20.
	string	No	The CIDR block of the NAT gateway that you want to query. Valid values of N: 1 to 20.	172.16.0.0/24

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The token that is used for the next query. Valid values: If the value of NextToken is not returned, it indicates that no next query is to be sent. If the value of NextToken is returned, the value indicates the token that is used for the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	7479A224-4A28-4895-9604-11F48BCE6A88
TotalCount	string	The number of CIDR blocks that are returned.	1
NatIpCidrs	array<object>	The CIDR blocks of the NAT gateway.
NatIpCidr	object
CreationTime	string	The time when the CIDR block was created.	2021-06-28T20:50Z
NatIpCidrId	string	The ID of the CIDR block of the NAT gateway.	vpcnatcidr-gw8ov42ei6xh1jys2****
IsDefault	boolean	Indicates whether the CIDR block is the default CIDR block of the NAT gateway. Valid values: true: The CIDR block is the default CIDR block of the NAT gateway. false: The CIDR block is not the default CIDR block of the NAT gateway.	true
NatIpCidrStatus	string	The status of the CIDR block of the NAT gateway. If Available is returned, it indicates that the CIDR block is available.	Available
NatIpCidrName	string	The name of the CIDR block of the NAT gateway.	Name
NatIpCidr	string	The CIDR block of the NAT gateway.	172.16.0.0/24
NatGatewayId	string	The ID of the VPC NAT gateway.	ngw-gw8v16wgvtq26vh59****
NatIpCidrDescription	string	The description of the CIDR block of the NAT gateway.	test

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-23	API Description Update. The Error code has changed	View Change Details
2023-03-01	The Error code has changed	View Change Details