DeleteVpcGatewayEndpoint-Virtual Private Cloud(VPC)-阿里云帮助中心

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DeleteVpcGatewayEndpoint

delete

*GatewayEndpoint

acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	Yes	The endpoint instance ID of the gateway endpoint.	vpce-bp1w1dmdqjpwul0v3****
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. ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different 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 without deleting the gateway endpoint. The system checks the AccessKey pair, the authorization of the Resource Access Management (RAM) user, and the required parameters. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): sends a Normal request, and the gateway endpoint is deleted after the check succeeds. A 2xx HTTP status code is returned.	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 elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A1122D0F-7B3B-5445-BB19-17F27F97FE1C

Examples

Success response

JSON format

{
  "RequestId": "A1122D0F-7B3B-5445-BB19-17F27F97FE1C"
}

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	IncorrectStatus.GatewayEndpoint	The status of GatewayEndpoint [%s] is incorrect.
400	DependencyViolation.Association	The specified resource of [%s] depends on [%s], so the operation cannot be completed.	The resource of the operation has dependencies. Please disassociate them first.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.