Delete a NAT CIDR block using DeleteNatIpCidr - NAT Gateway - Alibaba Cloud - NAT Gateway

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DeleteNatIpCidr

delete

*NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the NAT gateway to which the NAT CIDR block to be deleted belongs. You can call the DescribeRegions operation to obtain the region ID.	eu-central-1
NatIpCidr	string	Yes	The NAT CIDR block to be deleted. Before you delete a NAT CIDR block, you must delete all NAT IP addresses in the CIDR block. You cannot delete the default NAT CIDR block.	172.16.0.0/24
DryRun	boolean	No	Specifies whether to perform only a dry run. Valid values: true: The system performs a dry run without deleting the NAT CIDR block. The system checks whether your AccessKey pair is valid, the authorization of the Resource Access Management (RAM) user, and whether the required parameters are specified. If the request fails the dry run, the corresponding error is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): The system sends a Normal request. If the request passes the dry run, a 2xx HTTP status code is returned and the NAT CIDR block is deleted.	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 ensure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatGatewayId	string	Yes	The instance ID of the NAT gateway instance to which the NAT CIDR block to be deleted belongs.	ngw-gw8v16wgvtq26vh59****
RegionId	string	Yes	The region ID of the NAT gateway to which the NAT CIDR block to be deleted belongs. You can call the DescribeRegions operation to query the region ID.	eu-central-1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7021BEB1-210F-48A9-AB82-BE9A9110BB89

Examples

Success response

JSON format

{
  "RequestId": "7021BEB1-210F-48A9-AB82-BE9A9110BB89"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.NatIpCidr	The specified resource of %s is not found.	The specified %s resource does not exist.
400	OperationFailed.DefaultNatIpCidr	The operation is failed because of default NatIPCidr can not be deleted.	The operation failed because you cannot delete the default CIDR block.
400	DependencyViolation.NatIp	The specified resource of %s depends on %s, so the operation cannot be completed.	You cannot perform the operation because the NAT gateway is associated with a NAT IP address.
400	IncorrectStatus.NatGateway	%The status of %s [%s] is incorrect.	The NAT gateway is in an invalid state.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.