UpdateVpcGatewayEndpointAttribute - Modify gateway endpoint - Virtual Private Cloud

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. Call GetVpcGatewayEndpointAttribute to query the task status:
- If the gateway endpoint is in the Updating state, the modification is in progress.
- If the gateway endpoint is in the Created state, the modification is complete.
You cannot call the UpdateVpcGatewayEndpointAttribute operation within a specific period of time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	Yes	The ID of the gateway endpoint 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 the policy syntax and structure, 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 specify this parameter, the system uses RequestId as ClientToken. The value of RequestId may differ for each API request.	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 DescribeRegions to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	E9654534-5A38-5545-813F-0403D49042FB

Examples

Success response

JSON format

{
  "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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.