All Products
Document Center


Last Updated: Dec 19, 2017


Adds an authorization to VPC.

  • This API is intended for API activators.
  • This authorizes the API gateway to access your VPC instances.

Request parameters

Name Type Required or not Description
Action String Yes Operation interface name, which is a required parameter; value: SetVpcAccess
VpcId String Yes ID of the VPC, which must be the ID of an available VPC in the same account
InstanceId String Yes ID of the instance in VPC (ECS/Server Load Balancer)
Port Integer Yes ID of the port corresponding to the instance
Name String Yes Custom authorization name, which must be unique and cannot be duplicated

Return parameters

Name Type Description
RequestId String ID of the current request


Request example

  2. &VpcId=vpc-uf657qec7lx42paw3q123
  3. &InstanceId=i-uf6bzcg1pr4oh5jjm123
  4. &Port=80
  5. &Name=test
  6. &<Public request parameters>

Return example

XML format

  1. <SetVpcAccessResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>
  3. </SetVpcAccessResponse>

JSON format

  1. {
  2. "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015"
  3. }