UpdateVpcGatewayEndpointAttribute - Virtual Private Cloud

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.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:UpdateVpcGatewayEndpointAttribute	update	GatewayEndpoint acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	Yes	The ID of the gateway endpoint that you want to modify.	vpce-bp1w1dmdqjpwul0v3****
EndpointName	string	No	The new name of the gateway endpoint. The name must be 1 to 128 characters in length.	update
EndpointDescription	string	No	The new description of the gateway endpoint. The description must be 1 to 255 characters in length.	updateendpoint
PolicyDocument	string	No	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" : [ "*" ] } ] }
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 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.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	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.	false
RegionId	string	Yes	The region ID of the gateway endpoint. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The returned information.
RequestId	string	The ID of the request.	E9654534-5A38-5545-813F-0403D49042FB

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.ConcurrentOperation	The operation is failed because of concurrent operation.	-
400	IdempotentParameterMismatch	The 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.	-
400	ResourceNotFound.GatewayEndpoint	The specified resource gateway endpoint is not found.	The error message returned because the specified gateway endpoint does not exist.
400	IllegalParam.PolicyDocument	The param of PolicyDocument is illegal.	-
400	IllegalParam.GatewayEndpointName	The param of GatewayEndpointName is illegal.	-
400	IllegalParam.GatewayEndpointDescription	The param of GatewayEndpointDescription is illegal.	-
400	SystemBusy	System is busy, please try again later.	-
400	Forbbiden	User not authorized to operate on the specified resource.	User not authorized to operate on the specified resource.
400	InvalidRegionId.NotFound	The regionId provided does not exist in our records.	The RegionId parameter is set to an invalid value. Specify a valid value and try again.
400	OperationDenied.PolicyDocument	The gatewayEndpoint does not support policy.	-
400	IncorrectStatus.GatewayEndpoint	The status of GatewayEndpoint [%s] is incorrect.	-
400	InvalidPolicy.WrongFormat	Invalid 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 time	Summary of changes	Operation
2023-05-29	The Error code has changed	View Change Details