All Products
Search
Document Center

API Gateway:ValidateVpcConnectivity

Last Updated:Jul 31, 2025

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ValidateVpcConnectivityget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VpcAccessIdstringYes

The ID of the VPC access authorization.

5f1b3216f9********e2c1297b6741dc
InstanceIdstringYes

The ID of the API Gateway instance.

apigateway-hz-72bc18******

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1
Connectedboolean

Indicates whether the API Gateway instance is connected to the port. Valid values:

  • true
  • false
True
IpTypestring

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

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history