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
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | Yes | The name of the authorization. The name must be unique. | test |
| VpcId | string | Yes | The ID of the VPC. The VPC must be an available one that belongs to the same account as the API. | 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 |
| Description | string | No | The description of the VPC. | description of the VPC |
| VpcTargetHostName | string | No | The host of the backend service. | iot.hu***ng.com |
| Tag | array<object> | No | The tag of objects that match the rule. You can specify multiple tags. | |
| object | No | |||
| Key | string | No | The key of the tag. | key |
| Value | string | No | The value of the tag. | 123 |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2023-12-07 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |