All Products
Search
Document Center

API Gateway:DescribeVpcAccesses

Last Updated:Jul 31, 2025

Queries VPC access authorizations.

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:DescribeVpcAccessesget
*Vpc
acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
NamestringNo

The name of the authorization. The name must be unique.

wuying-edm-svc
VpcAccessIdstringNo

The ID of the VPC authorization.

vpc-*****ssds24
AccurateQuerybooleanNo

Whether to conduct precise queries

false
VpcIdstringNo

The ID of the VPC.

vpc-uf657qec7lx42paw3qxxx
InstanceIdstringNo

The ID of the instance.

10.199.26.***
PortstringNo

The service port.

8080
Tagarray<object>No

The port number.

objectNo
KeystringNo

The tag key.

appname
ValuestringNo

The tag value.

product

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSizeinteger

The number of entries returned on each page.

10
TotalCountinteger

The total number of returned entries.

1
VpcAccessAttributesarray<object>

The information about the VPC access authorization. The information is an array consisting of VpcAccessAttribute data.

VpcAccessAttributeobject
VpcIdstring

The VPC ID.

vpc-uf657qec7lx42paw3qxxx
Descriptionstring

The description of the VPC access authorization.

Test
InstanceIdstring

The ID of an Elastic Compute Service (ECS) or Server Load Balancer (SLB) instance in the VPC.

i-uf6bzcg1pr4oh5jjmxxx
Portinteger

The port number that corresponds to the instance.

80
Namestring

The name of the authorization.

test
CreatedTimestring

The time when the authorization was created.

2017-01-30T04:10:19Z
RegionIdstring

The region ID.

cn-hangzhou
VpcAccessIdstring

The ID of the VPC access authorization.

vpc-*****ssds24
VpcTargetHostNamestring

The host of the backend service.

hos-a***.fh-**nc.com
Tagsarray<object>

The tags.

TagInfoobject
Keystring

The tag key.

PROJECT
Valuestring

The tag value.

6427a17ae6041d1be62414e4

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
  "PageSize": 10,
  "TotalCount": 1,
  "VpcAccessAttributes": {
    "VpcAccessAttribute": [
      {
        "VpcId": "vpc-uf657qec7lx42paw3qxxx",
        "Description": "Test\n",
        "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

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

Change history

Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details
2024-05-11The request parameters of the API has changedView Change Details
2023-12-07The request parameters of the API has changed. The response structure of the API has changedView Change Details
2021-12-31The request parameters of the API has changedView Change Details