DescribeOutgoingDestinationIP - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the information about the destination IP addresses in outbound connections.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:DescribeOutgoingDestinationIP	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the response. Valid values: zh (default) en	zh
StartTime	string	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1656837360
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1656923760
PageSize	string	No	The number of entries to return on each page. Default value: 6. Maximum value: 10.	10
CurrentPage	string	No	The number of the page to return. Default value: 1.	1
CategoryId	string	No	The ID of the service to which the destination IP address belongs. This parameter is left empty by default. Valid values: All: all services RiskDomain: risky domain names RiskIP: risky IP addresses AliYun: Alibaba Cloud services NotAliYun: third-party services	All
DstIP	string	No	The destination IP address in the outbound connection that is initiated to access a domain name.	10.0.XX.XX
PublicIP	string	No	The public IP address of the Elastic Compute Service (ECS) instance that initiates the outbound connection.	192.0.XX.XX
PrivateIP	string	No	The private IP address of the ECS instance that initiates the outbound connection.	192.168.XX.XX
Port	string	No	The port number.	80
Sort	string	No	The field based on which you want to sort the query results. Valid values: SessionCount (default): the number of requests. TotalBytes: the total volume of traffic.	SessionCount
Order	string	No	The method that you want to use to sort the query results. Valid values: asc desc (default)	desc
TagIdNew	string	No	The ID of the tag. Valid values: AliYun: Alibaba Cloud service RiskDomain: risky domain name RiskIP: risky IP address TrustedDomain: trusted website AliPay: Alipay DingDing: DingTalk WeChat: WeChat QQ: Tencent QQ SecurityService: security service Microsoft: Microsoft Amazon: Amazon Web Services (AWS) Pan: cloud disk Map: map Code: code hosting SystemService: system service Taobao: Taobao Google: Google ThirdPartyService: third-party service FirstFlow: the first time Downloader: malicious download Alexa Top1M: popular website Miner: mining pool Intelligence: threat intelligence DDoS: DDoS trojan Ransomware: ransomware Spyware: spyware Rogue: rogue software Botnet: botnet Suspicious: suspicious website C&C: command and control (C&C) Gang: gang CVE: Common Vulnerabilities and Exposures (CVE) Backdoor: webshell Phishing: phishing website APT: advanced persistent threat (APT) attack Supply Chain Attack: supply chain attack Malicious software: malware	AliYun
ApplicationName	string	No	The application type in the access control policy. Valid values: FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL_No_Cert SSL VNC Note The value of this parameter depends on the value of Proto. If you set Proto to TCP, you can set ApplicationNameList to any valid value. If you specify both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.	FTP

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of destination IP addresses in outbound connections.	50
RequestId	string	The ID of the request.	F0F82705-CFC7-5F83-86C8-A063892F****
DstIPList	array<object>	The IP addresses in outbound connections.
DstIPData	object	The IP address.
AclCoverage	string	Indicates whether an access control policy is configured. Valid values: Uncovered: no FullCoverage: yes	Uncovered
DstIP	string	The destination IP addresses in outbound connections.	10.0.XX.XX
AclRecommendDetail	string	The suggestion to configure an access control policy.	Allows the traffic.
HasAclRecommend	boolean	Indicates whether an access control policy is recommended. Valid values: true false	true
InBytes	long	The inbound traffic. Unit: bytes.	472
CategoryName	string	The type of the service to which the destination IP address belongs. Valid values: Alibaba Cloud services Third-party services	Alibaba Cloud services
RuleName	string	The name of the access control policy.	Default rule
RuleId	string	The UUID of the access control policy.	fadsfd-dfadf-df****
SessionCount	long	The number of requests.	4
GroupName	string	The name of the group to which the access control policy belongs.	Rule_test
SecuritySuggest	string	The suggestion to handle the traffic of the domain name in outbound connections. Valid values: pass: allow alert: deny drop: monitor	pass
OutBytes	long	The outbound traffic. Unit: bytes.	965
AclStatus	string	The status of the access control policy. Valid values: normal: healthy Abnormal: unhealthy	Normal
IsMarkNormal	boolean	Indicates whether the destination IP address is added to a whitelist. Valid values: true false	true
CategoryId	string	The ID of the service type. Valid values: Aliyun: Alibaba Cloud services NotAliyun: third-party services	Aliyun
TagList	array<object>	The tags.
tag	object	The tag.
RiskLevel	integer	The risk level. Valid values: 1: low. 2: medium. 3: high.	1
TagName	string	The name of the tag.	Tag that indicates traffic is allowed
TagId	string	The ID of the tag.	AliYun
TagDescribe	string	The description of the tag.	Tag that indicates traffic is allowed
ClassId	string	The type of the tag. Valid values: Suspicious Malicious Trusted	Trusted
ApplicationPortList	array<object>	The application ports. Note Only the first 100 application ports are displayed.
appPort	object	The ports.
Port	integer	The application port.	80
ApplicationName	string	The application type used in the access control policy. Valid values: FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL_No_Cert SSL VNC Note The value of this parameter depends on the value of the Proto parameter. If you set Proto to TCP, you can set ApplicationNameList to any valid value. If you configure both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.	HTTP
CategoryClassId	string	The type of the tag. Valid values: Suspicious Malicious Trusted	Trusted
SecurityReason	string	The reason why the domain name is secure.	Intelligent policy: The destination domain name belongs to Alibaba Cloud Computing Co., Ltd. The domain name mainly provides services for Alibaba Cloud. No security risks are found, and you can add the domain name to the whitelist.
TotalBytes	string	The total traffic. Unit: bytes	800
HasAcl	string	Indicates whether an access control policy is configured. Valid values: true false	true
AddressGroupList	array<object>	The information about the address book.
addressGroup	object
AddressGroupUUID	string	The UUID of the address book.	f04ac7ce-628b-4cb7-be61-310222b7****
AddressGroupName	string	The name of the address book.	IP address book
AssetCount	long	The outbound asset count.	20
PrivateAssetCount	long	The outbound private asset count.	20
LocationName	string	Location name.

Examples

Sample success responses

JSONformat

{
  "TotalCount": 50,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DstIPList": [
    {
      "AclCoverage": "Uncovered",
      "DstIP": "10.0.XX.XX",
      "AclRecommendDetail": "Allows the traffic.\n",
      "HasAclRecommend": true,
      "InBytes": 472,
      "CategoryName": "Alibaba Cloud services\n",
      "RuleName": "Default rule\n",
      "RuleId": "fadsfd-dfadf-df****",
      "SessionCount": 4,
      "GroupName": "Rule_test\n",
      "SecuritySuggest": "pass",
      "OutBytes": 965,
      "AclStatus": "Normal",
      "IsMarkNormal": true,
      "CategoryId": "Aliyun",
      "TagList": [
        {
          "RiskLevel": 1,
          "TagName": "Tag that indicates traffic is allowed\n",
          "TagId": "AliYun",
          "TagDescribe": "Tag that indicates traffic is allowed\n",
          "ClassId": "Trusted"
        }
      ],
      "ApplicationPortList": [
        {
          "Port": 80,
          "ApplicationName": "HTTP"
        }
      ],
      "CategoryClassId": "Trusted",
      "SecurityReason": "Intelligent policy: The destination domain name belongs to Alibaba Cloud Computing Co., Ltd. The domain name mainly provides services for Alibaba Cloud. No security risks are found, and you can add the domain name to the whitelist.\n",
      "TotalBytes": "800",
      "HasAcl": "true",
      "AddressGroupList": [
        {
          "AddressGroupUUID": "f04ac7ce-628b-4cb7-be61-310222b7****",
          "AddressGroupName": "IP address book\n"
        }
      ],
      "AssetCount": 20,
      "PrivateAssetCount": 20,
      "LocationName": ""
    }
  ]
}

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	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorPortError	The port is invalid.	The port 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	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorDataTypeError	The data type is invalid.	The data type is invalid.
400	ErrorMarshalJSON	internal error.	Internal error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-24	The Error code has changed. The response structure of the API has changed	View Change Details
2024-09-06	API Description Update. The Error code has changed	View Change Details
2022-07-07	Add Operation	View Change Details