DescribeAssetList-阿里云帮助中心

Queries information about assets protected by Cloud Firewall.

Operation description

Use this API to query a paginated list of assets protected by Cloud Firewall.

QPS limit

The QPS limit for this API is 10 calls per second for a single user. If you exceed this limit, API calls are throttled.

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

get

*Asset

acs:cloudfirewall::{#accountId}:asset/{#Type}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	zh
CurrentPage	string	Yes	The page number to return.	1
PageSize	string	Yes	The number of assets to return per page.	10
RegionNo	string	No	The region ID of your Cloud Firewall instance. Note For more information about the regions that Cloud Firewall supports, see Supported regions.	cn-hangzhou
Status	string	No	The protection status of the asset. Valid values: open: Protection is enabled. opening: Protection is being enabled. closed: Protection is disabled. closing: Protection is being disabled. Note If you do not specify this parameter, assets are queried regardless of their protection status.	open
SearchItem	string	No	The IP address or instance ID of the asset.	192.0.XX.XX
Type	string	No	This parameter is deprecated.	eip
ResourceType	string	No	The asset type. Valid values: BastionHostEgressIP: The egress IP address of a Bastionhost instance. BastionHostIngressIP: The ingress IP address of a Bastionhost instance. EcsEIP: The Elastic IP Address (EIP) of an ECS instance. EcsPublicIP: The public IP address of an ECS instance. EIP: An Elastic IP Address (EIP). EniEIP: The EIP of an elastic network interface (ENI). NatEIP: The EIP of a NAT Gateway instance. SlbEIP: The EIP of a Server Load Balancer (SLB) or Classic Load Balancer (CLB) instance. SlbPublicIP: The public IP address of a Server Load Balancer (SLB) or Classic Load Balancer (CLB) instance. NatPublicIP: The public IP address of a NAT Gateway instance. HAVIP: A High-availability Virtual IP (HAVIP). NlbEIP: The EIP of a Network Load Balancer (NLB) instance. ApiGatewayEIP: The public IP address of an API Gateway instance. AlbEIP: The EIP of an Application Load Balancer (ALB) instance. AiGatewayEIP: The public IP address of an AI Gateway instance. GaEIP: The EIP of a Global Accelerator (GA) instance. SwasEIP: The public IP address of a Simple Application Server instance. EcdEIP: The public IP address of a Wuying instance. BastionHostIP: The IP address of a Bastionhost instance.	EIP
SgStatus	string	No	The status of the security group policy. Valid values: pass: The security group policy is enforced. block: The security group policy is not enforced. unsupport: The asset does not support security group policies. Note If you do not specify this parameter, assets are queried regardless of the security group policy status.	pass
IpVersion	string	No	The IP version of the asset. Valid values: 4 (default): IPv4 6: IPv6	4
MemberUid	integer	No	The UID of the member account.	258039427902****
UserType	string	No	The type of the user. Valid values: buy (default): A user with a paid subscription. free: A user on the free tier.	buy
NewResourceTag	string	No	Filters for assets discovered within a specific time window. Valid values: discovered in 1 hour: The asset was added within the last hour. discovered in 1 day: The asset was added within the last day. discovered in 7 days: The asset was added within the last 7 days.	discovered in 1 hour
OutStatistic	string	No	Specifies whether to query information about outbound traffic.	true
SensitiveStatus	string	No	The status of the data leak detection feature.	open

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of assets protected by Cloud Firewall.	12
RequestId	string	The request ID.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Assets	array<object>	The details of the assets protected by Cloud Firewall.
	object
RiskLevel	string	The risk level of the asset. Valid values: low: Low risk. middle: Medium risk. high: High risk. Note This parameter is returned only if the `UserType` parameter is set to `free`.	low
BindInstanceName	string	The name of the instance that is associated with the asset.	instance01
Type	string	This parameter is deprecated.	eip
SgStatusTime	integer	The timestamp of the last security group status check. Unit: seconds.	1615082937
ResourceInstanceId	string	The ID of the asset instance.	i-8vbdrjrxzt78****
MemberUid	integer	The UID of the Cloud Firewall member account.	258039427902****
IntranetAddress	string	The private IP address of the asset.	192.168.XX.XX
SyncStatus	string	Indicates whether the asset supports traffic redirection. Valid values: enable: Traffic redirection is supported. disable: Traffic redirection is not supported.	enable
AliUid	integer	The UID of the Alibaba Cloud account. Note The UID of the management account to which the member account belongs.	158039427902****
ProtectStatus	string	The protection status of the asset. Valid values: open: Protected. opening: Enabling protection. closed: Not protected. closing: Disabling protection.	open
InternetAddress	string	The public IP address of the asset.	192.0.XX.XX
BindInstanceId	string	The ID of the instance that is associated with the asset.	i-8vbdrjrxzt78****
RegionID	string	The region ID of the asset.	cn-hangzhou
RegionStatus	string	Indicates whether the asset's region supports Cloud Firewall protection. Valid values: enable: Supported. disable: Not supported.	enable
ResourceType	string	The type of the asset. Valid values: BastionHostEgressIP: The egress IP address of a bastion host. BastionHostIngressIP: The ingress IP address of a bastion host. EcsEIP: The EIP of an ECS instance. EcsPublicIP: The public IP address of an ECS instance. EIP: A standalone EIP. EniEIP: The EIP of an elastic network interface (ENI). NatEIP: The EIP of a NAT gateway. SlbEIP: The EIP of a Classic Load Balancer (CLB) instance. SlbPublicIP: The public IP address of a Classic Load Balancer (CLB) instance. NatPublicIP: The public IP address of a NAT gateway. HAVIP: A high-availability virtual IP (HAVIP). NlbEIP: The EIP of a Network Load Balancer (NLB) instance. ApiGatewayEIP: The EIP of an API Gateway instance. AlbEIP: The EIP of an Application Load Balancer (ALB) instance. AiGatewayEIP: The EIP of an AI Gateway instance. GaEIP: The EIP of a Global Accelerator (GA) instance. SwasEIP: The public IP address of a Simple Application Server instance. EcdEIP: The public IP address of an Elastic Desktop Service (EDS) instance. BastionHostIP: The IP address of a bastion host.	EIP
IpVersion	integer	The IP version of the asset. Valid values: Values: 4: An IPv4 address. 6: An IPv6 address.	4
SgStatus	string	The status of the security group policy. Valid values: pass: The policy is applied. block: The policy is not applied. unsupport: Not supported.	block
Note	string	Additional information about the asset. Valid values: REGION_NOT_SUPPORT: The region is not supported. NETWORK_NOT_SUPPORT: The network type is not supported.	REGION_NOT_SUPPORT
Name	string	The name of the asset instance.	instance01
CreateTimeStamp	string	The time when the asset was discovered by Cloud Firewall, in YYYY-MM-DD HH:mm:ss format.	2023-02-28 10:29:58
NewResourceTag	string	A tag that indicates how recently the asset was discovered. Valid values: discovered in 1 hour: The asset was discovered within the last hour. discovered in 1 day: The asset was discovered within the last 24 hours. discovered in 7 days: The asset was discovered within the last 7 days.	discovered in 1 hour
SensitiveDataStatus	string	Indicates whether data leak prevention is enabled.	open
Last7DayOutTrafficBytes	integer	The amount of outbound traffic from the asset in the last 7 days, in bytes.	0

Examples

Success response

JSON format

{
  "TotalCount": 12,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Assets": [
    {
      "RiskLevel": "low",
      "BindInstanceName": "instance01",
      "Type": "eip",
      "SgStatusTime": 1615082937,
      "ResourceInstanceId": "i-8vbdrjrxzt78****",
      "MemberUid": 0,
      "IntranetAddress": "192.168.XX.XX",
      "SyncStatus": "enable",
      "AliUid": 0,
      "ProtectStatus": "open",
      "InternetAddress": "192.0.XX.XX",
      "BindInstanceId": "i-8vbdrjrxzt78****",
      "RegionID": "cn-hangzhou",
      "RegionStatus": "enable",
      "ResourceType": "EIP",
      "IpVersion": 4,
      "SgStatus": "block",
      "Note": "REGION_NOT_SUPPORT",
      "Name": "instance01",
      "CreateTimeStamp": "2023-02-28 10:29:58",
      "NewResourceTag": "discovered in 1 hour",
      "SensitiveDataStatus": "open",
      "Last7DayOutTrafficBytes": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.