Modifies the name and description of a NAT IP address.

Usage notes

You cannot repeatedly call the ModifyNatIpAttribute operation to modify the name and description of a NAT IP address within the specified period of time.

Debugging

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 parameter

Parameter Type Required Example Description
RegionId String Yes eu-central-1

The region ID of the NAT gateway to which the NAT IP address that you want to modify belongs.

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

NatIpId String Yes vpcnatip-gw8e1n11f44wpg****

The ID of the NAT IP address that you want to modify.

NatIpName String Yes newname

The name of the NAT IP address that you want to modify.

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. It cannot start with http:// or https://.

NatIpDescription String Yes test

The description of the NAT IP address that you want to modify.

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

DryRun Boolean No false

Specifies whether only to precheck this request. Valid values:

  • true: sends the precheck request but does not modify the name or description of the NAT IP address. The system checks your AccessKey pair, the Resource Access Management (RAM) user permissions, and the required parameters. If the request fails the precheck, an error message is returned. If the request passes the precheck, 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.
ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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 client token can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
Action String Yes ModifyNatIpAttribute

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

Response parameters

Parameter Type Example Description
RequestId String 6CC9456C-2E29-452A-9180-B6926E51B5CA

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatIpId=vpcnatip-gw8e1n11f44wpg****
&NatIpName=newname
&NatIpDescription=test
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&Action=ModifyNatIpAttribute
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyNatIpAttributeResponse>
    <RequestId>6CC9456C-2E29-452A-9180-B6926E51B5CA</RequestId>
</ModifyNatIpAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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. The error message returned because the specified region ID does not exist.

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