Query Asset Risk Levels Using DescribeAssetRiskList - Cloud Firewall - Alibaba Cloud - Cloud Firewall

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	47.100.XX.XX
Lang	string	No	The language type of the response message. Valid values: zh (default): Chinese en: English	zh
IpVersion	integer	Yes	The IP version of the assets protected by Cloud Firewall. Valid values: 4 (default): IPv4 6: IPv6	4
IpAddrList	array	No	The list of IP addresses to query. Separate multiple IP addresses with commas (,). You can query up to 20 IP addresses at a time. This parameter is required in practice. If this parameter is not specified, the API returns a 400 error. Note IPv4 example: 47.97.XX.XX. IPv6 example: 2001:db8:ffff:ffff:ffff:XXXX:ffff.
	string	No	The list of IP addresses to query. Separate multiple IP addresses with commas (,). You can query up to 20 IP addresses at a time. Note IPv4 example: 47.97.XX.XX. IPv6 example: 2001:db8:ffff:ffff:ffff:XXXX:ffff.	47.97.XX.XX

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	12
RequestId	string	The request ID.	443C5781-1C03-5FCD-8EC5-FB9C0B9AC396
AssetList	array<object>	The asset details returned.
	object	The asset details returned.
RiskLevel	string	The risk level. Valid values: low: low risk middle: medium risk high: high risk	low
Ip	string	The server IP address.	39.108.XX.XX
IpVersion	integer	The IP address version of the assets protected by Cloud Firewall. Valid values: 4: IPv4 address. 6: IPv6 address.	4
Reason	string	The risk reason.	other

Examples

Success response

JSON format

{
  "TotalCount": 12,
  "RequestId": "443C5781-1C03-5FCD-8EC5-FB9C0B9AC396",
  "AssetList": [
    {
      "RiskLevel": "low",
      "Ip": "39.108.XX.XX",
      "IpVersion": 4,
      "Reason": "other"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParameters	A parameter error occurred.	A parameter error occurred.
400	MissingParameter.IpAddrList	The required parameter 'IpAddrList' is missing. Provide at least one IP address in IpAddrList.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.