Query VPC Firewall Traffic Asset List via API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries the list of assets that access domain names through a VPC firewall.

Operation description

Queries asset information for VPC Access. When calling this operation, set IsAITraffic to "true". Otherwise, error code -340103 is returned.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	zh
StartTime	string	Yes	The start time. This value is a UNIX timestamp in seconds.	1656664560
EndTime	string	Yes	The end time. This value is a UNIX timestamp in seconds.	1656750960
PageSize	string	No	The number of entries per page.	10
CurrentPage	string	No	The current page number.	1
IP	string	No	The IP address of the asset.	47.92.x.x
Domain	string	No	The domain name.	www.****.com
Sort	string	No	The sort order. Valid values: asc, desc.	desc
Order	string	No	The sort field. Valid values: TotalBytes: sorts by total traffic. SessionCount: sorts by session count. Default value: TotalBytes.	SessionCount
VpcId	string	No	The ID of the VPC where the asset resides.	vpc-m5ewlqkuf7orclr1****
IsAITraffic	string	Yes	Specifies whether to collect only the traffic that accesses AI services. This parameter is required. Set this parameter to "true". Otherwise, a parameter error is returned.	true

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	132
RequestId	string	The request ID.	C5BE1AA4-934A-5085-89CC-9AD1CAC3****
DataList	array<object>	The data list.
	object	The data list.
IP	string	The IP address of the asset.	a.com
VpcId	string	The ID of the VPC where the asset resides.	a.com
TotalBytes	integer	The total traffic. Unit: bytes.	253023143
SessionCount	integer	The number of sessions.	12
IpsHitCnt	integer	The number of IPS hits.	10
VpcName	string	The name of the VPC where the asset resides.	vpc-bp1mos0vhefmx5ah6****

Examples

Success response

JSON format

{
  "TotalCount": 132,
  "RequestId": "C5BE1AA4-934A-5085-89CC-9AD1CAC3****",
  "DataList": [
    {
      "IP": "a.com",
      "VpcId": "a.com",
      "TotalBytes": 253023143,
      "SessionCount": 12,
      "IpsHitCnt": 10,
      "VpcName": "vpc-bp1mos0vhefmx5ah6****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorTimeError	The time is invalid.	The time is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorIpFormat	The IP address is invalid.	The IP address is invalid.
400	ErrorSecuritySuggest	The security suggest is invalid.	The security suggest is invalid.
400	ErrorSortError	The sort is invalid.	The sort is invalid.
400	ErrorOrderFailed	The order is invalid.	The order is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorDomainName	The domain name is invalid.	The domain name is invalid.
400	ErrorDataTypeError	The data type is invalid.	The data type is invalid.
400	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.