Revoke VPC Access via RemoveVpcAccess API - API Gateway

Operation description

This API is intended for API providers.
Revokes the permissions of API Gateway to access your VPC instance.

Note

Deleting an authorization affects the associated API. Before you delete the authorization, make sure that it is not used by the API.

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

apigateway:RemoveVpcAccess

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	Yes	The ID of the VPC.	vpc-uf657qec7lx42paw3qxxx
InstanceId	string	Yes	The ID of an ECS or SLB instance in the VPC.	i-uf6bzcg1pr4oh5jjmxxx
Port	integer	Yes	The port number that corresponds to the instance.	80
NeedBatchWork	boolean	No	Specifies whether batch work is required.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
Apis	object
Api	array<object>	API operations
	object
ApiId	string	API Id	551877242a4b4f3a84a56b7c3570e4a7
StageId	string	The ID of the runtime environment.	d1e1ee28f9fb4b729db0ee8ca76ff0a5
GroupId	string	The ID of the API group.	78d54ac4424d4b1792e33ca35637e8e4

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "Apis": {
    "Api": [
      {
        "ApiId": "551877242a4b4f3a84a56b7c3570e4a7",
        "StageId": "d1e1ee28f9fb4b729db0ee8ca76ff0a5",
        "GroupId": "78d54ac4424d4b1792e33ca35637e8e4"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.