Query VPC Firewall Access Details via API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves the access details of a VPC firewall.

Operation description

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

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

yundun-cloudfirewall:DescribeVpcFirewallAccessDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type. Valid values: zh (default): Chinese en: English	zh
StartTime	string	Yes	The start time of the query. The value is a UNIX timestamp. Unit: seconds.	1655778046
EndTime	string	Yes	The end time of the query. The value is a UNIX timestamp. Unit: seconds.	1729042555
VpcId	string	Yes	The VPC-connected instance ID.	vpc-2ze4xj5kmb5udb****
Port	string	No	The port number. You must specify at least one of AssetIP and Port. If both are left empty, the API returns a 400 error.	80
Direction	string	No	The traffic direction. Valid values: in: inbound. out: outbound. Note If you do not configure this parameter in Settings, traffic in all directions is queried.	in
IPProtocol	string	No	The protocol type. Valid values: tcp: TCP protocol. udp: UDP protocol.	tcp
RiskLevel	string	No	The risk assessment level.	3
PeerVpcId	string	No	The instance ID of the peer VPC.	vpc-90rq0anm6t8vbwbo****
PeerAssetIP	string	No	The source IP address of the peer.	10.125.1.XX
PeerAssetInstanceId	string	No	The instance ID of the peer asset.	i-123451
PeerAssetInstanceName	string	No	The instance name of the peer asset.	ecs22
AssetIP	string	No	The IP address of the local asset. You must specify at least one of AssetIP and Port. If both are left empty, the API returns a 400 error.	192.0.XX.XX
Sort	string	No	The sort field. Valid values: InBytes OutBytes TotalBytes InPackets OutPackets SessionCount	InBytes
Order	string	No	The sort order. Valid values: asc: ascending order. desc (default): descending order.	desc
CurrentPage	string	No	The page number in a paged query.	1
PageSize	string	No	The number of entries per page in a paged query.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	9
RequestId	string	The request ID.	8EAC2347-E85A-5DFF-9F49-B8E1BAFB****
DataList	array<object>	The data list.
	object	The data entry.
SessionCount	integer	The total number of sessions.	27
PeerAssetInstanceId	string	The instance ID of the peer.	i-123451
PeerAssetIP	string	The source IP address of the peer.	10.125.1.XX
RegionNo	string	The region ID of the instance.	cn-shenzhen
OutBytes	integer	The number of bytes sent. Unit: bytes.	1123
InBytes	integer	The number of bytes received. Unit: bytes.	17845821669
peerVpcName	string	The name of the peer VPC.	vpc-test
PeerVpcId	string	The instance ID of the peer VPC.	vpc-123411
PeerAssetInstanceName	string	The instance name of the peer.	test

Examples

Success response

JSON format

{
  "TotalCount": 9,
  "RequestId": "8EAC2347-E85A-5DFF-9F49-B8E1BAFB****",
  "DataList": [
    {
      "SessionCount": 27,
      "PeerAssetInstanceId": "i-123451",
      "PeerAssetIP": "10.125.1.XX",
      "RegionNo": "cn-shenzhen",
      "OutBytes": 1123,
      "InBytes": 17845821669,
      "peerVpcName": "vpc-test",
      "PeerVpcId": "vpc-123411\n",
      "PeerAssetInstanceName": "test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParameters	AssetIP and Port cannot be empty at the same time.
400	MissingParameter.AssetIpOrPort	At least one of AssetIP or Port is required.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.