All Products
Search

This Product

    NAT Gateway:ModifyNatIpCidrAttribute

    Document Center

    NAT Gateway:ModifyNatIpCidrAttribute

    Last Updated:Aug 28, 2026

    Modifies the name and description of a NAT CIDR block.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

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

    You can call the DescribeRegions operation to query available regions.

    eu-central-1
    NatIpCidrName

    string

    No

    The new name of the NAT CIDR block.

    The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

    newname
    DryRun

    boolean

    No

    Whether to perform only a dry run without sending the actual request. Valid values:

    • true: performs only a dry run. The system checks for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.

    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

    false
    ClientToken

    string

    No

    The client token that ensures the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note

    If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

    5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    NatIpCidrDescription

    string

    No

    The new description of the NAT CIDR block.

    The description must be 2 to 256 characters in length and must start with a letter but cannot start with http:// or https://.

    newtest
    NatGatewayId

    string

    Yes

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

    ngw-gw8v16wgvtq26vh59****
    NatIpCidr

    string

    Yes

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

    172.16.0.0/24
    RegionId

    string

    Yes

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

    You can call the DescribeRegions operation to query available regions.

    eu-central-1

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0ED8D006-F706-4D23-88ED-E11ED28DCAC0

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalParamFormat.NatIpCidr The param format of NatIpCidr is illegal. The param format of NatIpCidr is illegal.
    404 ResourceNotFound.NatIpCidr The specified resource of NatIpCidr is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.