All Products
Document Center

Virtual Private Cloud:UpdateVpcGatewayEndpointAttribute

Last Updated:Dec 01, 2023

Modifies the configuration of a gateway endpoint.

Operation Description

  • UpdateVpcGatewayEndpointAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetVpcGatewayEndpointAttribute operation to query the status of the task.

    • If the gateway endpoint is in the Updating state, it is being modified.
    • If the gateway endpoint is in the Created state, it is modified.
  • You cannot call the UpdateVpcGatewayEndpointAttribute operation within a specific period of time.


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:
    • 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
  • GatewayEndpoint

Request parameters


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


The new name of the gateway endpoint.

The name must be 1 to 128 characters in length.


The new description of the gateway endpoint.

The description must be 1 to 255 characters in length.


The access policy for the cloud service.

For more information about the syntax and structure of the access policy, see Policy syntax and structure.

{ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }

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 all requests. The token can contain only ASCII characters.

Note If you do not set this parameter, the system uses RequestId as ClientToken. The value of RequestId of each API request may be different.

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks your AccessKey pair, the RAM user permissions, and the required parameters If the request fails the dry run, the corresponding error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

The region ID of the gateway endpoint.

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


Response parameters


The returned information.


The ID of the request.



Sample success responses


  "RequestId": "E9654534-5A38-5545-813F-0403D49042FB"

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.ConcurrentOperationThe operation is failed because of concurrent operation.-
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.-
400ResourceNotFound.GatewayEndpointThe specified resource gateway endpoint is not found.The error message returned because the specified gateway endpoint does not exist.
400IllegalParam.PolicyDocumentThe param of PolicyDocument is illegal.-
400IllegalParam.GatewayEndpointNameThe param of GatewayEndpointName is illegal.-
400IllegalParam.GatewayEndpointDescriptionThe param of GatewayEndpointDescription is illegal.-
400SystemBusySystem is busy, please try again later.-
400ForbbidenUser not authorized to operate on the specified resource.The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
400InvalidRegionId.NotFoundThe regionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
400OperationDenied.PolicyDocumentThe gatewayEndpoint does not support policy.-
400IncorrectStatus.GatewayEndpointThe status of GatewayEndpoint [%s] is incorrect.-
400InvalidPolicy.WrongFormatInvalid input policy format.The format of the policy information is invalid.

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

Change history

Change timeSummary of changesOperation
2023-05-29The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change