All Products
Search
Document Center

API Gateway:RemoveVpcAccess

Last Updated:Mar 01, 2024

Deletes a VPC access authorization without unpublishing the associated APIs.

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.

Debugging

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

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
apigateway:RemoveVpcAccessWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VpcIdstringYes

The ID of the VPC.

vpc-uf657qec7lx42paw3qxxx
InstanceIdstringYes

The ID of an ECS or SLB instance in the VPC.

i-uf6bzcg1pr4oh5jjmxxx
PortintegerYes

The port number that corresponds to the instance.

80
NeedBatchWorkbooleanNo

Specifies whether batch work is required.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
Apisobject []

API operations

ApiIdstring

API Id

551877242a4b4f3a84a56b7c3570e4a7
StageIdstring

The ID of the runtime environment.

d1e1ee28f9fb4b729db0ee8ca76ff0a5
GroupIdstring

The ID of the API group.

78d54ac4424d4b1792e33ca35637e8e4

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history