DescribeOutgoingAssetList - Cloud Firewall - Alibaba Cloud Documentation Center

Retrieves a list of assets with 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

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

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the content. Valid values: en : English zh : Chinese	zh
StartTime	string	Yes	The start of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1743647114
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1736438400
PageSize	string	No	The number of entries to return on each page.	10
CurrentPage	string	No	The page number.	1
ResourceType	string	No	The type of the public IP address of the asset. Valid values: EcsEIP : EIP of an ECS instance EcsPublicIP : Public IP address of an ECS instance NatPublicIP : Public IP address of a NAT Gateway NatEIP : EIP of a NAT Gateway	NatEIP
AssetsRegion	string	No	The region ID of the asset.	cn-beijing
GroupName	string	No	The follow status. Valid values: subscribe : followed ignore : ignored	subscribe
PublicIP	string	No	The public IP address.	47.116.70.XXX
PrivateIP	string	No	The private IP address.	10.200.33.XXX
SecurityRisk	string	No	The security risk. Valid values: normal : normal risk : risky	risk
Sort	string	No	The sorting basis. Valid values: InBytes : inbound traffic SessionCount : number of sessions OutBytes : outbound traffic	InBytes
Order	string	No	The sorting order. Valid values: asc : ascending desc : descending	desc
IPType	string	No	Queries outbound connections routed from a private network through a NAT gateway.	NatPrivate
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-bp123456g******
NatGatewayName	string	No	The name of the NAT Gateway.	ngw-test

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	2
RequestId	string	The request ID.	7A515672-FAAE-584F-B51C-B2586E****
AssetList	array<object>	The list of assets.
	object	The list of assets.
SessionCount	integer	The number of sessions.	2
ResourceType	string	The type of the public IP address of the asset. Valid values: EcsEIP : EIP of an ECS instance EcsPublicIP : Public IP address of an ECS instance NatPublicIP : Public IP address of a NAT Gateway NatEIP : EIP of a NAT Gateway EIP : EIP	EcsPublicIP
AssetInstanceId	string	The ID of the asset instance.	i-8vbcmllue4d94nto****
GroupName	string	The follow status. Valid values: subscribe : followed ignore : ignored	subscribe
AssetsRegion	string	The region ID.	cn-hangzhou
OutBytes	integer	The outbound traffic, which is the request traffic. Unit: bytes.	100
SecurityRisk	string	The security risk. Valid values: normal : normal risk : risky	risk
InBytes	integer	The inbound traffic, which is the response traffic. Unit: bytes.	244438.0
PublicIP	string	The public IP address.	47.96.181.XXX
AssetInstanceName	string	The name of the asset instance.	test
PrivateIP	string	The private IP address.	10.21.242XXX
NatGatewayId	string	The ID of the NAT Gateway.	ngw-bp1utx6wj4x9qu9tl****
NatGatewayName	string	The name of the NAT Gateway.	ngw-test
OutgoingDomainCnt	integer	The number of outbound domains.	10
OutgoingDstIPCnt	integer	The number of outbound destination IP addresses.	12
TotalBytes	integer	The total traffic.	12498767
PrivateIPList	array	The list of private IP addresses.
	string	A private IP address in the list.	["47.256.35.XXX"]
IpsHitCnt	integer	The number of IPS hits.	12

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "7A515672-FAAE-584F-B51C-B2586E****",
  "AssetList": [
    {
      "SessionCount": 2,
      "ResourceType": "EcsPublicIP",
      "AssetInstanceId": "i-8vbcmllue4d94nto****",
      "GroupName": "subscribe",
      "AssetsRegion": "cn-hangzhou",
      "OutBytes": 100,
      "SecurityRisk": "risk",
      "InBytes": 244438,
      "PublicIP": "47.96.181.XXX",
      "AssetInstanceName": "test",
      "PrivateIP": "10.21.242XXX",
      "NatGatewayId": "ngw-bp1utx6wj4x9qu9tl****",
      "NatGatewayName": "ngw-test",
      "OutgoingDomainCnt": 10,
      "OutgoingDstIPCnt": 12,
      "TotalBytes": 12498767,
      "PrivateIPList": [
        "[\"47.256.35.XXX\"]"
      ],
      "IpsHitCnt": 12
    }
  ]
}

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	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorIpFormat	The IP address is invalid.	The IP address is invalid.
400	ErrorSecurityRisk	The security risk is invalid.	The security risk is invalid.
400	ErrorSortError	The sort is invalid.	The sort is invalid.
400	ErrorOrderFailed	The order is invalid.	The order is invalid.
400	ErrorSecuritySuggest	The security suggest is invalid.	The security suggest is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.