DescribeOutgoingDomainDetail-阿里云帮助中心

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

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address.	121.15.137.XXX
Lang	string	No	The language of the response. Valid values: en : English zh（默认） : Chinese (default) zh(Default) : Chinese zh (default) : Chinese	zh
Lang	string	No	The language of the response. Valid values: en : English zh（默认） : Chinese (default) zh(Default) : Chinese zh (default) : Chinese	zh
StartTime	string	Yes	The start of the time range to query. The value is a UNIX timestamp in seconds.	1753617600
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp in seconds.	1733450528
PageSize	string	No	The number of entries to return per page.	10
CurrentPage	string	No	The page number to return.	1
TagId	string	No	The tag ID to filter by. Valid values: FirstFlow : First access Period : Periodic	FirstFlow
AclCoverage	string	No	The policy coverage status to filter by. Valid values: All : All FullCoverage : Covered Uncovered : Not covered PartialCoverage : Partially covered	FullCoverage
Domain	string	No	The domain name to query.	example.com
PublicIP	string	No	The public IP address to query.	47.96.181.XXX
PrivateIP	string	No	The private IP address to query.	10.210.0.XXX
Sort	string	No	The field to sort the results by. Valid values: InBytes : inbound traffic SessionCount : session count OutBytes : outbound traffic	OutBytes
Order	string	No	The sort order. Valid values: asc : ascending desc : descending	desc
IPType	string	No	The IP address type. Set to `NatPrivate` to query details for outbound connections that originate from a private IP address via a NAT Gateway.	NatPrivate
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-uf62zzi7000bca7zn****
DomainList	array	No	A list of domain names to query.
	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 request ID.	98AF5888-9606-59CF-888F-032A9ED0****
ApplicationNameList	array	The list of application names.
	string	The application name.	['HTTP', 'HTTPS']
AssetList	array<object>	The list of assets.
	array<object>	An asset.
AclCoverage	string	The policy coverage status. Valid values: All : All FullCoverage : Covered Uncovered : Not covered PartialCoverage : Partially covered	FullCoverage
ResourceInstanceName	string	The asset instance name.	test
ResourceInstanceId	string	The asset instance ID.	i-uf63wjhyoohc1g4z****
RegionNo	string	The region ID.	cn-beijing
InBytes	integer	The inbound traffic (response traffic), in bytes.	244438.0
FirstTime	integer	The first access time, as a Unix timestamp in seconds.	1738548990
PrivateIP	string	The private IP address.	10.21.242XXX
RuleId	string	The ACL rule ID.	08a58465-ff4d-4c47-8782-eb008301****
RuleName	string	The rule name.	test
SessionCount	integer	The session count.	10
LastTime	integer	The last access time, as a Unix timestamp in seconds.	1739326614
ResourceType	string	The type of the asset's public IP address. Valid values: EcsEIP : An Elastic IP Address (EIP) associated with an ECS instance. EcsPublicIP : A public IP address of an ECS instance. NatPublicIP : A public IP address of a NAT Gateway. NatEIP : An EIP associated with a NAT Gateway. EIP : An EIP.	NatEIP
OutBytes	integer	The outbound traffic (request traffic), in bytes.	100
PublicIP	string	The public IP address.	47.96.181.XXX
TagList	array<object>	The list of tags.
	object	The tag.
RiskLevel	integer	The risk level. Valid values: 0 : No risk 1 : Low risk 2 : Medium risk 3 : High risk	0
TagName	string	The tag name.	test
TagId	string	The tag ID. Valid values: FirstFlow : First access Period : Periodic	FirstFlow
TagDescribe	string	The tag description.	test
ClassId	string	The risk classification ID.	3
TotalBytes	string	The total traffic, in bytes.	321120825843
VpcId	string	The VPC ID.	vpc-9dp16jgwgyvn****
NatGatewayId	string	The NAT Gateway ID.	ngw-bp1utx6wj4x9qu9tl****
NatGatewayName	string	The NAT Gateway name.	ngw-test
IpsHitCnt	integer	The IPS hit count.	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.