All Products
Search
Document Center

Virtual Private Cloud:ModifyNatIpCidrAttribute

Last Updated:Mar 01, 2024

Modifies the name and description of a NAT CIDR block.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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.

eu-central-1
NatIpCidrNamestringYes

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
DryRunbooleanNo

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

  • 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): 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
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 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
NatIpCidrDescriptionstringNo

The new description of the NAT CIDR block.

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

newtest
NatGatewayIdstringYes

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

ngw-gw8v16wgvtq26vh59****
NatIpCidrstringYes

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

172.16.0.0/24

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
404ResourceNotFound.NatIpCidrThe specified resource of NatIpCidr is not found.

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

Change history

Change timeSummary of changesOperation
2023-03-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404