Modifies the description or name of an IPv4 gateway.

Usage notes

You cannot repeatedly call the UpdateIpv4GatewayAttribute operation to modify the name or description of an IPv4 gateway 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 parameters

Parameter Type Required Example Description
Action String Yes UpdateIpv4GatewayAttribute

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

Ipv4GatewayId String Yes ipv4gw-5tsnc6s4ogsedtp3k****

The ID of the IPv4 gateway whose name or description you want to modify.

Ipv4GatewayName String No newname

The new name of the IPv4 gateway.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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, the system uses RequestId as ClientToken. RequestId may be different for each API request.
DryRun Boolean No false

Specifies whether to check the request without performing the operation. Valid values:

  • true: checks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.
Ipv4GatewayDescription String No new

The new description of the IPv4 gateway.

RegionId String Yes ap-southeast-6

The region ID of the IPv4 gateway whose name or description you want to modify.

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

Response parameters

Parameter Type Example Description
RequestId String 671CEB03-C98D-5916-950C-C55B0BD06621

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateIpv4GatewayAttribute
&Ipv4GatewayId=ipv4gw-5tsnc6s4ogsedtp3k****
&Ipv4GatewayName=newname
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&Ipv4GatewayDescription=new
&RegionId=ap-southeast-6
&Common request parameters

Sample success responses

XML format 

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

<UpdateIpv4GatewayAttributeResponse>
    <RequestId>671CEB03-C98D-5916-950C-C55B0BD06621</RequestId>
</UpdateIpv4GatewayAttributeResponse>

JSON format 

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

{
  "RequestId" : "671CEB03-C98D-5916-950C-C55B0BD06621"
}

Error codes

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