All Products
Search
Document Center

API Gateway:DescribeVpcAccesses

Last Updated:Feb 09, 2023

Queries authorized VPCs.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
apigateway:DescribeVpcAccessesRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*
    without
without

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 unique custom name for authorization.

wuying-edm-svc
VpcAccessIdstringNo

The ID of the VPC authorization.

vpc-*****ssds24
VpcIdstringNo

The ID of the VPC.

vpc-uf657qec7lx42paw3qxxx
InstanceIdstringNo

The ID of the instance.

10.199.26.***
PortstringNo

The service port.

8080

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 per page.

10
TotalCountinteger

The total number of returned entries.

1
VpcAccessAttributesarray

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

object

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

VpcIdstring

The ID of the VPC.

vpc-uf657qec7lx42paw3qxxx
Descriptionstring

The description of the VPC authorization.

Test
InstanceIdstring

The ID of an ECS or 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 ID of the region.

cn-hangzhou
VpcAccessIdstring

The ID of the VPC authorization.

vpc-*****ssds24
VpcTargetHostNamestring

The host of the backend service.

hos-a***.fh-**nc.com

Example

Normal return example

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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2021-12-31The input parameters of the API operation has changed
Change itemChange content
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: VpcId
    Added Input Parameters: InstanceId
    Added Input Parameters: Port