DescribeVpcAccesses for querying VPC access authorizations - API Gateway - Alibaba Cloud - API Gateway

Queries VPC access authorizations.

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

get

*Vpc

acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
Name	string	No	The name of the authorization. The name must be unique.	wuying-edm-svc
VpcAccessId	string	No	The ID of the VPC authorization.	vpc-*****ssds24
AccurateQuery	boolean	No	Whether to conduct precise queries	false
VpcId	string	No	The ID of the VPC.	vpc-uf657qec7lx42paw3qxxx
InstanceId	string	No	The ID of the instance.	10.199.26.***
Port	string	No	The service port.	8080
Tag	array<object>	No	The port number.
	object	No
Key	string	No	The tag key.	appname
Value	string	No	The tag value.	product

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of returned entries.	1
VpcAccessAttributes	object
VpcAccessAttribute	array<object>	The information about the VPC access authorization. The information is an array consisting of VpcAccessAttribute data.
	array<object>
VpcId	string	The VPC ID.	vpc-uf657qec7lx42paw3qxxx
Description	string	The description of the VPC access authorization.	Test
InstanceId	string	The ID of an Elastic Compute Service (ECS) or Server Load Balancer (SLB) instance in the VPC.	i-uf6bzcg1pr4oh5jjmxxx
Port	integer	The port number that corresponds to the instance.	80
Name	string	The name of the authorization.	test
CreatedTime	string	The time when the authorization was created.	2017-01-30T04:10:19Z
RegionId	string	The region ID.	cn-hangzhou
VpcAccessId	string	The ID of the VPC access authorization.	vpc-*****ssds24
VpcTargetHostName	string	The host of the backend service.	hos-a*.fh-nc.com
Tags	object
TagInfo	array<object>	The tags.
	object
Key	string	The tag key.	PROJECT
Value	string	The tag value.	6427a17ae6041d1be62414e4

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
  "PageSize": 10,
  "TotalCount": 1,
  "VpcAccessAttributes": {
    "VpcAccessAttribute": [
      {
        "VpcId": "vpc-uf657qec7lx42paw3qxxx",
        "Description": "Test",
        "InstanceId": "i-uf6bzcg1pr4oh5jjmxxx",
        "Port": 80,
        "Name": "test",
        "CreatedTime": "2017-01-30T04:10:19Z",
        "RegionId": "cn-hangzhou",
        "VpcAccessId": "vpc-*****ssds24",
        "VpcTargetHostName": "hos-a***.fh-**nc.com",
        "Tags": {
          "TagInfo": [
            {
              "Key": "PROJECT",
              "Value": "6427a17ae6041d1be62414e4"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.