DescribeApisByVpcAccess - API Gateway - Alibaba Cloud Documentation Center

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

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeApisByVpcAccess	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
VpcName	string	Yes	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 parameters

Parameter	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	array<object>	The returned API information. It is an array consisting of ApiInfo data.
ApiVpcAccessInfo	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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details