Audit Outbound Traffic Destinations via Cloud Firewall API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries outbound connection destinations.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp `deprecated`	string	No	The IP address of the access source. [Deprecated]	106.3.198.XXX
Lang	string	No	The language type of the received message.	zh
StartTime	string	Yes	The start time of the query. The value is a UNIX timestamp in seconds.	1749657600
EndTime	string	Yes	The end time of the query. The value is a UNIX timestamp in seconds.	1749089441
PageSize	string	No	The number of entries per page.	10
CurrentPage	string	No	The page number.	1
CategoryId	string	No	The category ID. Valid values: RiskDomain : risky domain names. AliYun : Alibaba Cloud services. NotAliYun : non-Alibaba Cloud services.	AliYun
TagId	string	No	The tag ID.	FirstFlow
SecuritySuggest	string	No	The security policy for the Outbound Domain. Valid values: drop : observe. pass : allow. alert : deny.	pass
AclCoverage	string	No	The policy coverage status.	FullCoverage
DstIP	string	No	The legacy destination IP parameter. Note The POP gateway passes this parameter through, but the backend of this operation does not read it. Specifying this parameter has no filtering effect. To filter by IP address, use PublicIP or PrivateIP. If only DstIP is specified, the operation returns MissingParameter.IpFilter (-340415) because no valid IP filtering parameter is provided.	47.100.111XXX
PublicIP	string	No	The public IP address. Note At least one of PublicIP and PrivateIP must be specified.	47.96.74.XXX
PrivateIP	string	No	The private IP address. Note At least one of PublicIP and PrivateIP must be specified.	10.111.53XXX
ApplicationName	string	No	The application name.	HTTP
Port	string	No	The port number.	3306
Sort	string	No	The field by which to sort the results. Valid values: InBytes : InBytes TotalBytes : TotalBytes SessionCount : SessionCount OutBytes : OutBytes	InBytes
Order	string	No	The sort order.	desc
IsAITraffic	string	No	Specifies whether to collect statistics only on traffic that accesses AI services. Default value: false. Valid values: true : yes. false : no.	true

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	42
RequestId	string	The request ID.	A2845BA9-1642-5B27-9F04-8014DD94****
DstList	array<object>	The destination address information.
	array<object>	The destination address information.
DstIP	string	The destination IP address.	101.6.15.XXX
AclRecommendDetail	string	The recommended ACL content.	RecommendedRelease
HasAclRecommend	boolean	Indicates whether a recommended ACL exists. Valid values: false : no. true : yes.	false
InBytes	integer	The inbound traffic. Unit: bytes.	0
DstType	string	The destination type.	domain
CategoryName	string	The category name of the product.	categor_test
DstDomain	string	The destination domain name.	example.com
SessionCount	integer	The number of sessions.	10
GroupName	string	The group name.	group-name
OutBytes	integer	The outbound traffic. Unit: bytes.	0
AclStatus	string	The policy status. Valid values: Normal : Normal. Abnormal : Abnormal.	Normal
CategoryId	string	The category ID. Valid values: RiskDomain : risky domain names. AliYun : Alibaba Cloud services. NotAliYun : non-Alibaba Cloud services.	AliYun
IsMarkNormal	boolean	Indicates whether the entry is manually marked as normal by the user. Valid values: true : yes. false : no.	false
TagList	array<object>	The tag list.
	object	The tag list.
RiskLevel	integer	The risk assessment level. Valid values: 0 : no risk. 1 : low risk. 2 : medium risk. 3 : high risk.	1
TagName	string	The tag name.	verify
TagId	string	The tag ID.	FirstFlow
TagDescribe	string	The tag description.	test
Business	string	The domain name business.	example.com

Examples

Success response

JSON format

{
  "TotalCount": 42,
  "RequestId": "A2845BA9-1642-5B27-9F04-8014DD94****",
  "DstList": [
    {
      "DstIP": "101.6.15.XXX",
      "AclRecommendDetail": "test",
      "HasAclRecommend": false,
      "InBytes": 0,
      "DstType": "domain",
      "CategoryName": "categor_test",
      "DstDomain": "example.com",
      "SessionCount": 10,
      "GroupName": "test",
      "OutBytes": 0,
      "AclStatus": "Normal",
      "CategoryId": "AliYun",
      "IsMarkNormal": false,
      "TagList": [
        {
          "RiskLevel": 1,
          "TagName": "verify",
          "TagId": "FirstFlow",
          "TagDescribe": "test"
        }
      ],
      "Business": "example.com"
    }
  ]
}

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	ErrorIpFormat	The IP address is invalid.	The IP address 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	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorDataTypeError	The data type is invalid.	The data type is invalid.
400	MissingParameter.IpFilter	At least one IP filter parameter (PublicIP, DstIP, SourceIp, or PrivateIP) is required.
400	InvalidParameter.PublicIP	The PublicIP parameter value is not a valid IP address.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.