Modifies the description or name of an IPv4 gateway.
Operation description
You cannot repeatedly call the UpdateIpv4GatewayAttribute operation to modify the name or description of an IPv4 gateway within the specified period of time.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:UpdateIpv4GatewayAttribute | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Ipv4GatewayId | string | Yes | The ID of the IPv4 gateway whose name or description you want to modify. | ipv4gw-5tsnc6s4ogsedtp3k**** |
| Ipv4GatewayName | string | No | The new name of the IPv4 gateway. | newname |
| ClientToken | string | No | 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.
| 123e4567-e89b-12d3-a456-426655440000 |
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
| Ipv4GatewayDescription | string | No | The new description of the IPv4 gateway. | new |
| RegionId | string | Yes | 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. | ap-southeast-6 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "671CEB03-C98D-5916-950C-C55B0BD06621"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ResourceNotFound.Ipv4Gateway | The specified resource ipv4Gateway is not found. | The IPv4 gateway is not found and cannot be deleted. |
| 400 | IncorrectStatus.Ipv4Gateway | The status of %s [%s] is incorrect. | The IPv4 gateway is in an invalid state. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-08-07 | API Description Update. The Error code has changed | see changesets | ||||||
|