Use ValidateVpcConnectivity to test network connectivity for VPC access - API Gateway - Alibaba Cloud - API Gateway

Tests the network connectivity between an API Gateway instance and a port on an Elastic Compute Service (ECS) or Server Load Balance (SLB) instance in a virtual private cloud (VPC) access authorization.

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:ValidateVpcConnectivity

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VpcAccessId	string	Yes	The ID of the VPC access authorization.	5f1b3216f9********e2c1297b6741dc
InstanceId	string	Yes	The ID of the API Gateway instance.	apigateway-hz-72bc18******

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1
Connected	boolean	Indicates whether the API Gateway instance is connected to the port. Valid values: true false	True
IpType	string	Indicates whether the instance in the authorization is an ECS instance or an SLB instance when the instance ID in the authorization is an IP address. Valid values: ECS SLB INVALID: The instance type corresponding to the IP address is invalid.	ECS

Examples

Success response

JSON format

{
  "RequestId": "9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1",
  "Connected": true,
  "IpType": "ECS"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.