Modifies the name and description of a NAT CIDR block.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyNatIpCidrAttribute

The operation that you want to perform. Set the value to ModifyNatIpCidrAttribute.

RegionId String Yes eu-central-1

The region ID of the NAT gateway to which the NAT CIDR block belongs.

You can call the DescribeRegions operation to query the most recent region list.

NatIpCidr String Yes

The NAT CIDR block whose name and description you want to modify.

NatGatewayId String Yes ngw-gw8v16wgvtq26vh59****

The ID of the Virtual Private Cloud (VPC) NAT gateway to which the NAT CIDR block belongs.

NatIpCidrName String Yes newname

The new name of the NAT CIDR block.

NatIpCidrDescription String No newtest

The new description of the NAT CIDR block.

ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

The client token that is used to ensure the idempotency. You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken can contain only ASCII characters. It cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses the request ID as the client token. The ID of each request may be unique.
DryRun Boolean No false

Specifies whether to precheck this request. Valid values:

  • true: sends the precheck request. Information about NAT CIDR blocks is not modified. The system checks whether the AccessKey pair is valid, whether the RAM user is authorized, and whether the required parameters are specified. If the request fails the precheck, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the API request. This is the default value. If the request passes the precheck, a 2XX HTTP status code is returned and information about the CIDR block is modified.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"

Error codes

For a list of error codes, visit the API Error Center.