All Products
Search

This Product

    NAT Gateway:ModifyNatIpAttribute

    Document Center

    NAT Gateway:ModifyNatIpAttribute

    Last Updated:Aug 28, 2026

    Modifies the name and description of a NAT IP address.

    Operation description

    Description

    You cannot call the ModifyNatIpAttribute operation to concurrently modify the name and description of the same NAT IP address.

    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 IP address belongs.

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

    eu-central-1
    NatIpId

    string

    Yes

    The ID of the NAT IP address.

    vpcnatip-gw8e1n11f44wpg****
    NatIpName

    string

    No

    The new name of the NAT IP address.

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

    newname
    NatIpDescription

    string

    No

    The new description of the NAT IP address.

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

    test
    DryRun

    boolean

    No

    Specifies whether to perform a dry run, without sending the actual request.

    • true: performs 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): sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the name and description of the NAT IP address are modified.

    false
    ClientToken

    string

    No

    The client token used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must ensure that it is unique among requests. The client 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
    RegionId

    string

    Yes

    The region ID of the NAT gateway to which the NAT IP address belongs.

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

    eu-central-1

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    6CC9456C-2E29-452A-9180-B6926E51B5CA

    Examples

    Success response

    JSON format

    {
  "RequestId": "6CC9456C-2E29-452A-9180-B6926E51B5CA"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.
    404 ResourceNotFound.NatIp The specified resource of NatIp is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.