All Products
Search
Document Center

Virtual Private Cloud:ModifyIpv6GatewayAttribute

Last Updated:Mar 21, 2025

Modifies the name and description of an IPv6 gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ModifyIpv6GatewayAttributeupdate
*Ipv6Gateway
acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
Ipv6GatewayIdstringYes

The ID of the IPv6 gateway that you want to modify.

ipv6gw-hp39kh1ya51yzp2lu****
NamestringNo

The name of the IPv6 gateway.

The name must be 0 to 128 characters in length and cannot start with http:// or https://.

ipv6name
DescriptionstringNo

The description of the IPv6 gateway.

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

ipv6description
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 invalid AccessKey pairs, unauthorized RAM users, and missing parameter values. If the request fails the dry run, an error message is returned. If the request passes dry run, the DryRunOperation error code is returned.
  • false: sends the API request. After the request passes the check, a 2XX HTTP status code is returned and the gateway endpoint is associated with the route table. This is the default value.
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.
02fb3da4-130e-11e9-8e44-0016e04115b

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

9DFEDBEE-E5AB-49E8-A2DC-CC114C67AF75

Examples

Sample success responses

JSONformat

{
  "RequestId": "9DFEDBEE-E5AB-49E8-A2DC-CC114C67AF75"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidIpv6GatewayId.NotFound%s-
400IllegalParam.Name%s-
400IllegalParam.Description%s-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.

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

Change history

Change timeSummary of changesOperation
2024-07-24The Error code has changed. The request parameters of the API has changedView Change Details
2023-08-15API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details