DescribeOutgoingDomainDetail - Cloud Firewall - Alibaba Cloud Documentation Center

Retrieves details about an outbound domain.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	121.15.137.XXX
Lang	string	No	The language of the response. Valid values: en : English zh（默认） : 中文 zh(Default) : Chinese	zh
Lang	string	No	The language of the response. Valid values: en : English zh（默认） : 中文 zh(Default) : Chinese	zh
StartTime	string	Yes	The start of the time range to query. This is a UNIX timestamp in seconds.	1753617600
EndTime	string	Yes	The end of the time range to query. This is a UNIX timestamp in seconds.	1733450528
PageSize	string	No	The page number to return.	10
CurrentPage	string	No	The page number.	1
TagId	string	No	The tag ID. Valid values: FirstFlow : First access Period : Periodic	FirstFlow
AclCoverage	string	No	The policy coverage status. Valid values: All : All FullCoverage : Covered Uncovered : Not covered PartialCoverage : Partially covered	FullCoverage
Domain	string	No	The domain name.	example.com
PublicIP	string	No	The public IP address.	47.96.181.XXX
PrivateIP	string	No	The private IP address.	10.210.0.XXX
Sort	string	No	The sorting criterion. Valid values: InBytes : Inbound traffic SessionCount : Number of sessions OutBytes : Outbound traffic	OutBytes
Order	string	No	The sort order. Valid values: asc : Ascending desc : Descending	desc
IPType	string	No	The outbound connections over NAT from a private network.	NatPrivate
NatGatewayId	string	No	The ID of the NAT gateway.	ngw-uf62zzi7000bca7zn****
DomainList	array	No	A list of domain names.
	string	No	A domain name.	['example.com']

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	8
RequestId	string	The ID of the request.	98AF5888-9606-59CF-888F-032A9ED0****
ApplicationNameList	array	A list of application names.
	string	An application name.	['HTTP', 'HTTPS']
AssetList	array<object>	A list of assets.
	array<object>	A list of assets.
AclCoverage	string	The policy coverage status. Valid values: All : All FullCoverage : Covered Uncovered : Not covered PartialCoverage : Partially covered	FullCoverage
ResourceInstanceName	string	The name of the asset instance.	test
ResourceInstanceId	string	The ID of the asset instance.	i-uf63wjhyoohc1g4z****
RegionNo	string	The region ID.	cn-beijing
InBytes	integer	The inbound traffic, which is the response traffic. Unit: bytes.	244438.0
FirstTime	integer	The timestamp of the first access.	1738548990
PrivateIP	string	The private IP address.	10.21.242XXX
RuleId	string	The ID of the access control list (ACL) rule.	08a58465-ff4d-4c47-8782-eb008301****
RuleName	string	The name of the rule.	test
SessionCount	integer	The number of access attempts.	10
LastTime	integer	The timestamp of the last access.	1739326614
ResourceType	string	The type of the public IP address for the asset. Valid values: EcsEIP : EcsEIP EcsPublicIP : EcsPublicIP NatPublicIP : NatPublicIP NatEIP : NatEIP EIP : EIP	NatEIP
OutBytes	integer	The outbound traffic, which is the request traffic. Unit: bytes.	100
PublicIP	string	The public IP address.	47.96.181.XXX
TagList	array<object>	A list of tags.
	object	The list of tags.
RiskLevel	integer	The risk level. Valid values: 0 : No risk 1 : Low risk 2 : Medium risk 3 : High risk	0
TagName	string	The name of the tag.	test
TagId	string	The ID of the tag. Valid values: FirstFlow : First access Period : Periodic	FirstFlow
TagDescribe	string	The description of the tag.	test
ClassId	string	The ID of the risk classification.	3
TotalBytes	string	The total traffic volume.	321120825843
VpcId	string	The ID of the VPC.	vpc-9dp16jgwgyvn****
NatGatewayId	string	The ID of the NAT gateway.	ngw-bp1utx6wj4x9qu9tl****
NatGatewayName	string	The name of the NAT gateway.	ngw-test
IpsHitCnt	integer	Indicates the number of IPS hits.	32
Domain	string	The domain name.	example.com

Examples

Success response

JSON format

{
  "TotalCount": 8,
  "RequestId": "98AF5888-9606-59CF-888F-032A9ED0****",
  "ApplicationNameList": [
    "['HTTP', 'HTTPS']"
  ],
  "AssetList": [
    {
      "AclCoverage": "FullCoverage",
      "ResourceInstanceName": "test",
      "ResourceInstanceId": "i-uf63wjhyoohc1g4z****",
      "RegionNo": "cn-beijing",
      "InBytes": 244438,
      "FirstTime": 1738548990,
      "PrivateIP": "10.21.242XXX",
      "RuleId": "08a58465-ff4d-4c47-8782-eb008301****",
      "RuleName": "test",
      "SessionCount": 10,
      "LastTime": 1739326614,
      "ResourceType": "NatEIP",
      "OutBytes": 100,
      "PublicIP": "47.96.181.XXX",
      "TagList": [
        {
          "RiskLevel": 0,
          "TagName": "test",
          "TagId": "FirstFlow",
          "TagDescribe": "test",
          "ClassId": "3"
        }
      ],
      "TotalBytes": "321120825843",
      "VpcId": "vpc-9dp16jgwgyvn****",
      "NatGatewayId": "ngw-bp1utx6wj4x9qu9tl****",
      "NatGatewayName": "ngw-test",
      "IpsHitCnt": 32,
      "Domain": "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	ErrorDomainName	The domain name is invalid.	The domain name is invalid.
400	ErrorSortError	The sort is invalid.	The sort 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	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorOrderFailed	The order is invalid.	The order 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.