DescribeApisByVpcAccess API Reference & VPC Authorization Overview - API Gateway

Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VpcName	string	No	The name of the VPC access authorization.	lynkco-iov-uat
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	2

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
RequestId	string	The request ID.	4E707B25-5119-5ACF-9D26-7D2A2762F05C
PageSize	integer	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	12
ApiVpcAccessInfos	object
ApiVpcAccessInfo	array<object>	The returned API information. It is an array consisting of ApiInfo data.
	object
ApiId	string	The API ID.	09839002de484e76b5a213b040a6a3ca
VpcId	string	vpc id	vpc-2ze7bj64wstznvftrskbk
InstanceId	string	The instance ID or IP address in the VPC access authorization.	Ib-04e41XXXXXd95e9c1
Port	integer	The port number.	443
RegionId	string	The region ID.	cn-shanghai
StageId	string	The environment ID.	57e17906a69b4424914fb1e05f67c78a
VpcName	string	The name of the VPC access authorization.	aliYun_service_prod
GroupId	string	The ID of the API group to which the API belongs.	41c33748cbfb41f6b00870156203b72a
GroupName	string	The name of the API group to which the API belongs.	RT_PLU_IP_CTRL_group
Description	string	The description, which can be up to 200 characters in length.	123
StageName	string	The environment to which the API is published. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
ApiName	string	The API name.	iwc
Path	string	The request path of the API.	/api/v1/friends/rc/status
Method	string	The HTTP request method of the API.	POST

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "4E707B25-5119-5ACF-9D26-7D2A2762F05C",
  "PageSize": 10,
  "TotalCount": 12,
  "ApiVpcAccessInfos": {
    "ApiVpcAccessInfo": [
      {
        "ApiId": "09839002de484e76b5a213b040a6a3ca",
        "VpcId": "vpc-2ze7bj64wstznvftrskbk",
        "InstanceId": "Ib-04e41XXXXXd95e9c1",
        "Port": 443,
        "RegionId": "cn-shanghai",
        "StageId": "57e17906a69b4424914fb1e05f67c78a",
        "VpcName": "aliYun_service_prod",
        "GroupId": "41c33748cbfb41f6b00870156203b72a",
        "GroupName": "RT_PLU_IP_CTRL_group",
        "Description": "123",
        "StageName": "RELEASE",
        "ApiName": "iwc",
        "Path": "/api/v1/friends/rc/status",
        "Method": "POST"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.