All Products
Search
Document Center

Cloud Firewall:DescribeOutgoingDomain

Last Updated:Dec 06, 2024

Queries the information about the domain names 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeOutgoingDomainget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request. Valid values:

  • zh: Chinese (default)
  • en: English
zh
StartTimestringYes

The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.

1656664560
EndTimestringYes

The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.

1656750960
PageSizestringNo

The number of entries to return on each page.

Default value: 6. Maximum value: 100.

10
CurrentPagestringNo

The number of the page to return.

Default value: 1.

1
CategoryIdstringNo

The type of the service. This parameter is 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
DomainstringNo

The domain name in outbound connections.

www.aliyundoc.com
PublicIPstringNo

The public IP address of the Elastic Compute Service (ECS) instance that initiates outbound connections.

192.0.XX.XX
SortstringNo

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
OrderstringNo

The method that is used to sort the results. Valid values:

  • asc: the ascending order.
  • desc (default): the descending order.
desc
TagIdNewstringNo

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 when an outbound connection is initiated
  • 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

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of the domain names in outbound connections.

132
RequestIdstring

The ID of the request.

F0F82705-CFC7-5F83-86C8-A063892F****
DomainListarray<object>

The domain names in outbound connections.

Dataobject

The domain name in the outbound connection.

AclCoveragestring

Indicates whether an access control policy is configured. Valid values:

  • Uncovered: no
  • FullCoverage: yes
Uncovered
Domainstring

The domain name in outbound connections.

www.aliyundoc.com
AclRecommendDetailstring

The suggestion in an access control policy.

Allows the traffic.
HasAclRecommendboolean

Indicates whether an access control policy is recommended. Valid values:

  • true: yes
  • false: no
true
InByteslong

The volume of inbound traffic.

3214
CategoryNamestring

The type of the service to which the domain name belongs. Valid values:

  • Alibaba Cloud services
  • Third-party services
Alibaba Cloud services
RuleNamestring

The name of the access control policy.

Default rule
RuleIdstring

The ID of the access control policy.

add-dfadf-f****
SessionCountlong

The number of requests.

12
GroupNamestring

The name of the group to which the access control policy belongs.

Group of addresses in outbound connections
SecuritySuggeststring

The suggestion to handle the traffic of the domain name in outbound connections. Valid values:

  • pass: allow
  • alert: monitor
  • drop: deny
pass
OutByteslong

The volume of outbound traffic.

4582
AclStatusstring

The state of the access control policy. Valid values:

  • normal: healthy
  • abnormal: unhealthy
Normal
IsMarkNormalboolean

Indicates whether the domain name is marked as normal. Valid values:

  • true: normal
  • false: abnormal
true
CategoryIdstring

The type ID of the service to which the domain name belongs. Valid values:

  • Aliyun: Alibaba Cloud services
  • NotAliyun: third-party services
Aliyun
AddressGroupUUIDstring

The UUID of the address book.

fdad-fdafa-dafa-dfa****
AddressGroupNamestring

The name of the address book.

The address book for outbound connections
CategoryClassIdstring

The type of the tag. Valid values:

  • Suspicious
  • Malicious
  • Trusted
Trusted
Businessstring

The website service.

Alibaba Cloud
HasAclstring

Indicates whether an access control policy is configured for the domain name. Valid values:

  • true: yes
  • false: no
true
Organizationstring

The name of the organization.

Alibaba Cloud Computing Co., Ltd.
SecurityReasonstring

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.
TotalBytesstring

The total volume of traffic. Unit: bytes.

800
TagListarray<object>

An array that consists of tags.

tagobject
RiskLevelinteger

The risk level. Valid values:

  • 1: low
  • 2: medium
  • 3: high
3
TagNamestring

The name of the tag.

Tag indicating that the domain name is added to the whitelist
TagIdstring

The ID of the tag.

AliYun
TagDescribestring

The description of the tag.

Tag indicating that the domain name is added to the whitelist
ClassIdstring

The type of the tag. Valid values:

  • Suspicious
  • Malicious
  • Trusted
Trusted
ApplicationNameListarray

The application names.

applicationNameListstring

The application names.

HTTP
AssetCountlong

The outbound asset count.

20
PrivateAssetCountlong

The outbound private asset count.

20

Examples

Sample success responses

JSONformat

{
  "TotalCount": 132,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DomainList": [
    {
      "AclCoverage": "Uncovered",
      "Domain": "www.aliyundoc.com",
      "AclRecommendDetail": "Allows the traffic.\n",
      "HasAclRecommend": true,
      "InBytes": 3214,
      "CategoryName": "Alibaba Cloud services\n",
      "RuleName": "Default rule\n",
      "RuleId": "add-dfadf-f****",
      "SessionCount": 12,
      "GroupName": "Group of addresses in outbound connections\n",
      "SecuritySuggest": "pass",
      "OutBytes": 4582,
      "AclStatus": "Normal",
      "IsMarkNormal": true,
      "CategoryId": "Aliyun",
      "AddressGroupUUID": "fdad-fdafa-dafa-dfa****",
      "AddressGroupName": "The address book for outbound connections\n",
      "CategoryClassId": "Trusted",
      "Business": "Alibaba Cloud\n",
      "HasAcl": "true",
      "Organization": "Alibaba Cloud Computing Co., Ltd.\n",
      "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",
      "TagList": [
        {
          "RiskLevel": 3,
          "TagName": "Tag indicating that the domain name is added to the whitelist\n",
          "TagId": "AliYun",
          "TagDescribe": "Tag indicating that the domain name is added to the whitelist\n",
          "ClassId": "Trusted"
        }
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "AssetCount": 20,
      "PrivateAssetCount": 20
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ErrorAliUidAliuid invalid.The aliuid is invalid.
400ErrorTimeErrorThe time is invalid.The time is invalid.
400ErrorDBSelectErrorA database select error occurred.The error message returned because an internal error has occurred in querying the database.
400ErrorIntervalErrorThe interval is invalid.The interval is invalid.
400ErrorIpFormatThe IP address is invalid.The IP address is invalid.
400ErrorSecuritySuggestThe security suggest is invalid.The security suggest is invalid.
400ErrorSortErrorThe sort is invalid.The sort is invalid.
400ErrorOrderFailedThe order is invalid.The order is invalid.
400ErrorPageNoEither page number or page size is invalid.Either page number or page size is invalid.
400ErrorDomainNameThe domain name is invalid.The domain name is invalid.
400ErrorDataTypeErrorThe data type is invalid.The data type is invalid.
400ErrorMarshalJSONinternal error.Internal error.

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

Change history

Change timeSummary of changesOperation
2024-09-24The Error code has changed. The response structure of the API has changedView Change Details
2024-09-06API Description Update. The Error code has changedView Change Details
2022-09-27The request parameters of the API has changed. The response structure of the API has changedView Change Details
2022-07-07Add OperationView Change Details