DescribeAssetList-阿里云帮助中心

Queries information about assets protected by Cloud Firewall.

Operation description

This API is generally used to query information about assets protected by Cloud Firewall with pagination.

QPS limit

The single-user QPS limit for this API is 10 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please make calls appropriately.

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 type of the response. Valid values: zh (default): Chinese. en: English.	zh
CurrentPage	string	Yes	The page number of the current page in a paginated query.	1
PageSize	string	Yes	The number of Cloud Firewall-protected assets to display on each page in a paginated query.	10
RegionNo	string	No	The region ID of the Cloud Firewall. Note For more information about regions supported by Cloud Firewall, see Supported regions.	cn-hangzhou
Status	string	No	The Cloud Firewall status. Valid values: open: Protected. opening: Protection enabling. closed: Not protected. closing: Protection disabling. Note If this parameter is not set, all firewall statuses are queried.	open
SearchItem	string	No	The IP address or instance ID of the asset.	192.0.XX.XX
Type `deprecated`	string	No	This parameter is deprecated.	eip
ResourceType	string	No	The asset type. Valid values: BastionHostEgressIP: Bastion host egress IP. BastionHostIngressIP: Bastion host ingress IP. EcsEIP: ECS EIP. EcsPublicIP: ECS public IP. EIP: Elastic IP address. EniEIP: Elastic network interface EIP. NatEIP: NAT EIP. SlbEIP: SLB EIP (CLB EIP). SlbPublicIP: SLB public IP (CLB public IP). NatPublicIP: NAT public IP. HAVIP: High-availability virtual IP. NlbEIP: NLB EIP. ApiGatewayEIP: API Gateway public IP. AlbEIP: ALB EIP. AiGatewayEIP: AI Gateway public IP. GaEIP: GA EIP. SwasEIP: Simple Application Server public IP. EcdEIP: Elastic Desktop Service public IP. BastionHostIP: Bastion host IP.	EIP
SgStatus	string	No	The security group policy status. Valid values: pass: Delivered. block: Not delivered. unsupport: Not supported. Note If this parameter is not set, all security group policy statuses are queried.	pass
IpVersion	string	No	The IP version of the assets protected by Cloud Firewall. Valid values: 4 (default): IPv4. 6: IPv6.	4
MemberUid	integer	No	The UID of the Cloud Firewall member account.	258039427902****
UserType	string	No	The user type. Valid values: buy (default): Paid user. free: Free user.	buy
NewResourceTag	string	No	The time when the asset was discovered. Valid values: discovered in 1 hour: The asset was discovered within 1 hour. discovered in 1 day: The asset was discovered within 1 day. discovered in 7 days: The asset was discovered within 7 days.	discovered in 1 hour
OutStatistic	string	No	Specifies whether to query outbound traffic information.	true
SensitiveStatus	string	No	The status of data leakage detection.	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 information about assets protected by Cloud Firewall.
	object
RiskLevel	string	The risk level of the asset. Valid values: low: Low risk. middle: Medium risk. hight: High risk. Note This parameter is returned only when the value of UserType is free.	low
BindInstanceName	string	The name of the bound asset instance.	instance01
Type `deprecated`	string	This parameter is deprecated.	eip
SgStatusTime	integer	The last security group status detection time, in timestamp format. Unit: seconds.	1615082937
ResourceInstanceId	string	The asset instance ID.	i-8vbdrjrxzt78****
MemberUid	integer	The UID of the Cloud Firewall member account.	258039427902****
IntranetAddress	string	The private IP address of the server.	192.168.XX.XX
SyncStatus	string	The traffic diversion support status of the asset. Valid values: enable: Traffic diversion supported. disable: Traffic diversion not supported.	enable
AliUid	integer	The UID of the Alibaba Cloud account. Note The primary account of the Cloud Firewall member account.	158039427902****
ProtectStatus	string	The firewall status. Valid values: open: Protected. opening: Protection enabling. closed: Not protected. closing: Protection disabling.	open
InternetAddress	string	The public IP address of the server.	192.0.XX.XX
BindInstanceId	string	The ID of the bound asset instance.	i-8vbdrjrxzt78****
RegionID	string	The region ID of the asset.	cn-hangzhou
RegionStatus	string	Indicates whether the region of the asset supports enabling Cloud Firewall protection. Valid values: enable: Supported. disable: Not supported.	enable
ResourceType	string	The asset type. Valid values: BastionHostEgressIP: Bastion host egress IP. BastionHostIngressIP: Bastion host ingress IP. EcsEIP: ECS EIP. EcsPublicIP: ECS public IP. EIP: Elastic IP address. EniEIP: Elastic network interface EIP. NatEIP: NAT EIP. SlbEIP: SLB EIP (CLB EIP). SlbPublicIP: SLB public IP (CLB public IP). NatPublicIP: NAT public IP. HAVIP: High-availability virtual IP. NlbEIP: NLB EIP. ApiGatewayEIP: API Gateway public IP. AlbEIP: ALB EIP. AiGatewayEIP: AI Gateway public IP. GaEIP: GA EIP. SwasEIP: Simple Application Server public IP. EcdEIP: Elastic Desktop Service public IP. BastionHostIP: Bastion host IP.	EIP
IpVersion	integer	The IP address version of the asset protected by Cloud Firewall. Valid values: 4: Indicates an IPv4 address. 6: Indicates an IPv6 address.	4
SgStatus	string	The security group policy. Valid values: pass: Delivered. block: Not delivered. unsupport: Not supported.	block
Note	string	The remarks of the asset. Valid values: REGION_NOT_SUPPORT: Region not supported. NETWORK_NOT_SUPPORT: Network not supported.	REGION_NOT_SUPPORT
Name	string	The instance name of the asset protected by Cloud Firewall.	instance01
CreateTimeStamp	string	The time when Cloud Firewall discovered the asset. Time format: YYYY-MM-DD HH:mm:ss.	2023-02-28 10:29:58
NewResourceTag	string	The time when the asset was discovered. Valid values: discovered in 1 hour: The asset was discovered within 1 hour. discovered in 1 day: The asset was discovered within 1 day. discovered in 7 days: The asset was discovered within 7 days.	discovered in 1 hour
SensitiveDataStatus	string	The status of data leakage detection.	open
Last7DayOutTrafficBytes	integer	The outbound traffic in the last 7 days.	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.