DescribeOutgoingDestination-阿里云帮助中心

This operation queries outbound 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	string	No	The source IP address of the visitor.	106.3.198.XXX
Lang	string	No	The language of the response message.	zh
Lang	string	No	The language of the response message.	zh
StartTime	string	Yes	The start of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1749657600
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1749089441
PageSize	string	No	The number of the page to return.	10
CurrentPage	string	No	The number of the page to return.	1
CategoryId	string	No	The category ID. Valid values: RiskDomain : Risky domain names AliYun : Alibaba Cloud services NotAliYun : Services that are not provided by Alibaba Cloud	AliYun
TagId	string	No	The tag ID.	FirstFlow
SecuritySuggest	string	No	The security policy for the outbound connection. Valid values: drop : Observe pass : Allow alert : Deny	pass
AclCoverage	string	No	The policy coverage status.	FullCoverage
DstIP	string	No	The destination IP address.	47.100.111XXX
PublicIP	string	No	The public IP address.	47.96.74.XXX
PrivateIP	string	No	The private IP address.	10.111.53XXX
ApplicationName	string	No	The application name.	HTTP
Port	string	No	The port number.	3306
Sort	string	No	The field to use for sorting. Valid values: InBytes : InBytes TotalBytes : TotalBytes SessionCount : SessionCount OutBytes : OutBytes	InBytes
Order	string	No	The sorting order.	desc
IsAITraffic	string	No	Specifies whether to count only the traffic to AI services. The default value is 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 ID of the request.	A2845BA9-1642-5B27-9F04-8014DD94****
DstList	array<object>	The information about the destination addresses.
	array<object>	The information about the destination addresses.
DstIP	string	The destination IP address.	101.6.15.XXX
AclRecommendDetail	string	The recommended Access Control List (ACL) details.	test
HasAclRecommend	boolean	Indicates whether a recommended ACL exists. Valid values: false : No true : Yes	false
InBytes	integer	The inbound traffic. Unit: bytes.	0.0
DstType	string	The destination type.	domain
CategoryName	string	The category name of the service.	categor_test
DstDomain	string	The destination domain name.	example.com
SessionCount	integer	The number of sessions.	10
GroupName	string	The group name.	test
OutBytes	integer	The outbound traffic. Unit: bytes.	0.0
AclStatus	string	The policy status. Valid values: Normal : Healthy Abnormal : Abnormal	Normal
CategoryId	string	The category ID. Valid values: RiskDomain : Risky domain names AliYun : Alibaba Cloud services NotAliYun : Services that are not provided by Alibaba Cloud	AliYun
IsMarkNormal	boolean	Indicates whether the destination is manually marked as normal. Valid values: true : Yes false : No	false
TagList	array<object>	The list of tags.
	object	The list of tags.
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 business to which the domain name belongs.	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.