All Products
Search
Document Center

API Gateway:SetVpcAccess

Last Updated:Mar 01, 2024

Creates a virtual private cloud (VPC) access authorization and enables reverse access.

Operation description

  • This operation is intended for API providers.
  • This operation is used to authorize API Gateway to access your VPC instance.

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

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the authorization. The name must be unique.

test
VpcIdstringYes

The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.

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
DescriptionstringNo

The description of the VPC.

description of the VPC
VpcTargetHostNamestringNo

The host of the backend service.

iot.hu***ng.com
Tagobject []No

The tag of objects that match the rule. You can specify multiple tags.

KeystringNo

The key of the tag.

key
ValuestringNo

The value of the tag.

123

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
VpcAccessIdstring

The ID of the VPC access authorization.

4c68e061860f441ab72af7404137440e

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "VpcAccessId": "4c68e061860f441ab72af7404137440e"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-07The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag
Output ParametersThe response structure of the API has changed.