All Products
Search
Document Center

Virtual Private Cloud:ModifyNatIpAttribute

Last Updated:Mar 04, 2024

Modifies the name and description of a NAT IP address.

Operation description

Description

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ModifyNatIpAttributeWrite
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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.

eu-central-1
NatIpIdstringYes

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

vpcnatip-gw8e1n11f44wpg****
NatIpNamestringYes

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. The name must start with a letter and cannot start with http:// or https://.

newname
NatIpDescriptionstringYes

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

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

test
DryRunbooleanNo

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

  • true: performs only a dry run. The system checks the request 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
ClientTokenstringNo

The client token that is used to ensure 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 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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404ResourceNotFound.NatIpThe specified resource of NatIp is not found.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-25API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 404
2023-03-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404