Call DescribeOutgoingDomain to query outbound domain information - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries domain name information about outbound connections.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type of the request message. Valid values:	zh
StartTime	string	Yes	The start time of the query. The value is a UNIX timestamp in seconds.	1656664560
EndTime	string	Yes	The end time of the query. The value is a UNIX timestamp in seconds.	1656750960
PageSize	string	No	The number of entries per page in a paged query.	10
CurrentPage	string	No	The page number to return in a paged query.	1
CategoryId	string	No	The product category. Default value: empty. Valid values:	All
Domain	string	No	The domain name of the outbound connections.	www.aliyundoc.com
PublicIP	string	No	The public IP address of the ECS instance that initiates the outbound connection.	192.0.XX.XX
Sort	string	No	The sort order based on the specified field. Valid values:	SessionCount
Order	string	No	The sort method. Valid values:	desc
TagIdNew	string	No	The intelligence tag ID. Valid values:	AliYun
DataType	string	No	The source of the traffic statistics. Default value: Internet firewall. Valid values:	nat
IsAITraffic	string	No	Specifies whether to collect statistics only on traffic that accesses AI services. Default value: no. Valid values:	true

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of outbound domains.	132
RequestId	string	The request ID.	F0F82705-CFC7-5F83-86C8-A063892F****
DomainList	array<object>	The list of outbound domains.
	array<object>	The list of outbound domains.
AclCoverage	string	Indicates whether the access control policy provides coverage. Valid values:	Uncovered
Domain	string	The domain name of the outbound connections.	www.aliyundoc.com
AclRecommendDetail	string	The ACL recommendation details.	RecommendedRelease
HasAclRecommend	boolean	Indicates whether an ACL recommendation exists. Valid values:	true
InBytes	integer	The inbound traffic.	3214
CategoryName	string	The category name of the product. Valid values:	Alibaba Cloud Product
RuleName	string	The ACL rule name.	acl-name
RuleId	string	The ACL rule ID.	add-dfadf-f****
SessionCount	integer	The number of requests.	12
GroupName	string	The group name of the rule.	group-name
SecuritySuggest	string	The security policy for the Outbound Domain. Valid values:	pass
OutBytes	integer	The outbound traffic.	4582
AclStatus	string	The health status of the access control policy. Valid values:	Normal
IsMarkNormal	boolean	Indicates whether the outbound domain is marked as normal. Valid values:	true
CategoryId	string	The product category ID. Valid values:	Aliyun
AddressGroupUUID	string	The UUID of the address book.	fdad-fdafa-dafa-dfa****
AddressGroupName	string	The name of the address book.	Outreach Address Book
CategoryClassId	string	The categorization of the intelligence label. Valid values:	Trusted
Business	string	The website business.	Aliyun
HasAcl	string	Indicates whether an ACL covers the management of this domain name. Valid values:	true
Organization	string	The organization name.	Alibaba Cloud Computing Limited
SecurityReason	string	The security reason.	Smart policy: The target domain name belongs to Aliyun Computing Co., Ltd., and its main business is Aliyun. No security risks have been found. It can be used to configure an outreach whitelist.
TotalBytes	string	The total traffic. Unit: bytes.	800
TagList	array<object>	The list of tags.
	object	The tag list object.
RiskLevel	integer	The risk assessment level. Valid values: 1: Low. 2: Medium. 3: High.	3
TagName	string	The tag name.	tag-name
TagId	string	The intelligence tags label ID.	AliYun
TagDescribe	string	The tag description.	tag-describe
ClassId	string	The categorization of the intelligence tags label. Valid values: Suspicious: Suspicious. Malicious: Malicious. Trusted: Trusted.	Trusted
ApplicationNameList	array	The application names.
	string	The list of application names.	HTTP
AssetCount	integer	The total number of assets with outbound connections.	20
PrivateAssetCount	integer	The total number of private network assets with outbound connections.	20
ApplicationPortList	array<object>	The list of application ports.
	object
Port	integer		443
ApplicationName	string		HTTP

Examples

Success response

JSON format

{
  "TotalCount": 132,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DomainList": [
    {
      "AclCoverage": "Uncovered",
      "Domain": "www.aliyundoc.com",
      "AclRecommendDetail": "RecommendedRelease",
      "HasAclRecommend": true,
      "InBytes": 3214,
      "CategoryName": "阿里云产品",
      "RuleName": "acl-name",
      "RuleId": "add-dfadf-f****",
      "SessionCount": 12,
      "GroupName": "group-name",
      "SecuritySuggest": "pass",
      "OutBytes": 4582,
      "AclStatus": "Normal",
      "IsMarkNormal": true,
      "CategoryId": "Aliyun",
      "AddressGroupUUID": "fdad-fdafa-dafa-dfa****",
      "AddressGroupName": "Outreach Address Book",
      "CategoryClassId": "Trusted",
      "Business": "Aliyun",
      "HasAcl": "true",
      "Organization": "Alibaba Cloud Computing Limited\n",
      "SecurityReason": "Smart policy: The target domain name belongs to Aliyun Computing Co., Ltd., and its main business is Aliyun. No security risks have been found. It can be used to configure an outreach whitelist.",
      "TotalBytes": "800",
      "TagList": [
        {
          "RiskLevel": 3,
          "TagName": "tag-name",
          "TagId": "AliYun",
          "TagDescribe": "tag-describe",
          "ClassId": "Trusted"
        }
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "AssetCount": 20,
      "PrivateAssetCount": 20,
      "ApplicationPortList": [
        {
          "Port": 443,
          "ApplicationName": "HTTP"
        }
      ]
    }
  ]
}

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.