DescribeOutgoingDestinationIPDetail-阿里云帮助中心

Retrieves the details of an outbound destination IP address.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	1.202.193.XXX
Lang	string	No	The language of the response message.	zh
Lang	string	No	Specifies the language of the message.	zh
StartTime	string	Yes	The start of the time range to query. This is a UNIX timestamp. Unit: seconds.	1749434787
EndTime	string	Yes	The end of the time range to query. This is a UNIX timestamp. Unit: seconds.	1733710383
PageSize	string	No	The number of the page to return.	10
CurrentPage	string	No	The number of the page to return.	1
TagId	string	No	The ID of the tag. Valid values: FirstFlow : First-time access Period : Periodic access	FirstFlow
AclCoverage	string	No	The status of the access control policy. Valid values: All : All FullCoverage : Covered Uncovered : Uncovered PartialCoverage : Partially covered	FullCoverage
DstIP	string	Yes	The destination IP address.	34.136.111.XXX
PublicIP	string	No	The public IP address.	192.0.XX.XX
PrivateIP	string	No	The private IP address.	10.210.0.XXX
Sort	string	No	The field to use for sorting. Valid values: InBytes : Inbound traffic SessionCount : Number of sessions OutBytes : Outbound traffic	InBytes
Order	string	No	The sort order. Valid values: asc : Ascending order desc : Descending order	desc
IPType	string	No	Describes the outbound connections from a private network through a NAT gateway.	NatPrivate
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-2zed6z6qkd7ogc****

Response elements

Element	Type	Description	Example
	object
LocationName	string	The name of the region.	Hangzhou
IspName	string	The ISP of the destination IP address.	telecom
RequestId	string	The ID of the request.	F0F82705-CFC7-5F83-86C8-A063892F****
TotalCount	integer	The total number of entries returned.	25
AssetList	array<object>	The list of assets.
	array<object>	The list of assets.
AclCoverage	string	The status of the access control policy. Valid values: All : All FullCoverage : Covered Uncovered : Uncovered PartialCoverage : Partially covered	FullCoverage
ResourceInstanceName	string	The name of the asset instance.	test
ResourceInstanceId	string	The instance ID of the cloud product.	i-uf63wjhyoohc1g4z****
RegionNo	string	The region ID.	cn-shanghai
InBytes	integer	The inbound traffic. Unit: bytes.	0.0
LocationName	string	The name of the region where the destination IP address is located.	Hangzhou
FirstTime	integer	The time of the first access. This is a UNIX timestamp. Unit: seconds.	1744682438
PrivateIP	string	The private IP address.	10.21.242XXX
RuleId	string	The rule ID.	08a58465-ff4d-4c47-8782-eb008301****
RuleName	string	The rule name.	test
SessionCount	integer	The number of sessions.	2
LastTime	integer	The time of the last access. This is a UNIX timestamp. Unit: seconds.	1739326614
ResourceType	string	The type of the public IP address of the asset. Valid values: EcsEIP : EcsEIP EcsPublicIP : EcsPublicIP NatPublicIP : NatPublicIP NatEIP : NatEIP EIP : EIP	EcsPublicIP
OutBytes	integer	The outbound traffic. Unit: bytes.	0.0
IspName	string	The ISP of the destination IP address.	telecom
PublicIP	string	The public IP address.	47.96.181.XXX
TotalBytes	string	The total traffic.	458681
VpcId	string	The ID of the VPC instance.	vpc-9dp16jgwgyvn****
NatGatewayId	string	The ID of the NAT Gateway.	ngw-bp1utx6wj4x9qu9tl****
NatGatewayName	string	The name of the NAT Gateway.	ngw-test
TagList	array<object>	The 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.	FirstFlow
TagDescribe	string	The description of the tag.	test
ClassId	string	The classification ID.	1

Examples

Success response

JSON format

{
  "LocationName": "Hangzhou",
  "IspName": "telecom",
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "TotalCount": 25,
  "AssetList": [
    {
      "AclCoverage": "FullCoverage",
      "ResourceInstanceName": "test",
      "ResourceInstanceId": "i-uf63wjhyoohc1g4z****",
      "RegionNo": "cn-shanghai",
      "InBytes": 0,
      "LocationName": "Hangzhou",
      "FirstTime": 1744682438,
      "PrivateIP": "10.21.242XXX",
      "RuleId": "08a58465-ff4d-4c47-8782-eb008301****",
      "RuleName": "test",
      "SessionCount": 2,
      "LastTime": 1739326614,
      "ResourceType": "EcsPublicIP",
      "OutBytes": 0,
      "IspName": "telecom",
      "PublicIP": "47.96.181.XXX",
      "TotalBytes": "458681",
      "VpcId": "vpc-9dp16jgwgyvn****",
      "NatGatewayId": "ngw-bp1utx6wj4x9qu9tl****",
      "NatGatewayName": "ngw-test",
      "TagList": [
        {
          "RiskLevel": 0,
          "TagName": "test",
          "TagId": "FirstFlow",
          "TagDescribe": "test",
          "ClassId": "1"
        }
      ]
    }
  ]
}

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	ErrorPortError	The port is invalid.	The port 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.