DescribeApisecAbnormals - Web Application Firewall - Alibaba Cloud Documentation Center

Queries API security risks.

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-waf:DescribeApisecAbnormals

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of the WAF instance.	waf_v2_public_cn-z***9g301
ApiId	string	No	The ID of the API that is associated with the risk.	bd9efb8ad******d9ca6
ApiFormat	string	No	The API that is associated with the risk.	/api/users/login
MatchedHost	string	No	The domain name or IP address of the API.	a.aliyun.com
StartTime	string	No	The start of the time range to query. The value is a UNIX timestamp in seconds. The time is in UTC.	1684252800
EndTime	string	No	The end of the time range to query. The value is a UNIX timestamp in seconds. The time is in UTC.	1684382100
OrderKey	string	No	The field to use for sorting. Valid values: discoverTime: The time when the risk was first detected. This is the default value. abnormalLevel: The risk level. latestDiscoverTime: The time when the risk was last detected.	firstTime
OrderWay	string	No	The sorting order. Valid values: desc: Descending order. This is the default value. asc: Ascending order.	desc
AbnormalLevel	string	No	The risk level. Valid values: high: High. medium: Medium. low: Low.	medium
AbnormalTag	string	No	The type of the risk. Note Call the DescribeApisecRules operation to obtain the supported risk types.	LackOfSpeedLimit
AbnormalId	string	No	The ID of the risk.	29c6401****99a2bad3943e26d8
UserStatus	string	No	The status of the risk. Valid values: toBeConfirmed: To be confirmed. confirmed: Confirmed. toBeFixed: To be fixed. fixed: Fixed (manually verified). ignored: Ignored. toBeVerified: To be verified by the system. notFixed: Verification failed. systemFixed: Fixed (verified by the system).	Confirmed
PageNumber	integer	No	The page number. Default value: 1.	2
PageSize	integer	No	The number of entries per page. Default value: 10.	10
Origin	string	No	The source of the risk type. Valid values: custom: Custom. default: Built-in.	custom
ApiTag	string	No	The business purpose of the API. Note Call the DescribeApisecRules operation to obtain the supported business purposes.	RegisterAPI
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is available only in hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to obtain information about hybrid cloud clusters.	546
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of returned entries.	5
RequestId	string	The request ID.	9469646C-F2CC-5F0F-8401-C53***4F46
Data	array<object>	The list of risks.
	object	The risk information.
AbnormalId	string	The ID of the risk.	7c1431f27ae7e9c8cc64095***68e
Origin	string	The source of the risk type. Valid values: custom: Custom. default: Built-in.	custom
LastestTime	integer	The time when the API asset was last accessed. The value is a UNIX timestamp in seconds. The time is in UTC.	1684252800
FirstTime	integer	The time when the API asset was first discovered. The value is a UNIX timestamp in seconds. The time is in UTC.	1701138088
AbnromalStatus	string	The status of the risk.	unresolved
ApiFormat	string	The API that is associated with the risk.	/api/login
ApiTag	string	The business purpose of the API. Note Call the DescribeApisecRules operation to obtain the supported business purposes.	SendMail
DiscoverTime	integer	The time when the risk was first detected. The value is a UNIX timestamp in seconds. The time is in UTC.	1684252800
UserStatus	string	The status of the risk. Valid values: toBeConfirmed: To be confirmed. confirmed: Confirmed. toBeFixed: To be fixed. fixed: Fixed (manually verified). ignored: Ignored. toBeVerified: To be verified by the system. notFixed: Verification failed. systemFixed: Fixed (verified by the system).	Confirmed
IgnoreTime	integer	The time when the user marked the risk as ignored. The value is a UNIX timestamp in seconds. The time is in UTC.	1684252800
Follow	integer	Indicates whether the risk is followed. Valid values: 1: The risk is followed. 0: The risk is not followed. This is the default value.	0
MatchedHost	string	The domain name or IP address of the API.	a.aliyun.com
Note	string	The remarks.	已通知业务
AbnormalEventNumber	integer	The number of events that are associated with the risk.	2
AbnormalTag	string	The type of the risk. Note Call the DescribeApisecRules operation to obtain the supported risk types.	LackOfSpeedLimit
AbnormalInfo	string	The details of the risk. The value is a string that is converted from a JSON object. The JSON object contains the following parameters: rule: The rule that corresponds to the risk. data_type: The type of sensitive data. custom_rule_name: The name of the custom rule. rule_name: The name of the built-in rule.	{ "data_type": ["1005","1004"], "rule": { "parent": "RiskType_Permission", "code": "Risk_UnauthSensitive", "level": "high", "origin": "default", "name": "Risk_UnauthSensitive" } }
ApiId	string	The ID of the API that is associated with the risk.	09559c0d71ca2ffc996b81***836d8
AbnormalLevel	string	The risk level. Valid values: high: High. medium: Medium. low: Low.	high
LatestDiscoverTime	integer	The time when the risk was last detected. The value is a UNIX timestamp in seconds. The time is in UTC.	1684252800
Examples `deprecated`	array	The list of risk samples.
	string	The sample information. The value is a string that is converted from a JSON object. The JSON object contains the following parameters: param_num: The number of API parameters. request_method: The request method. protocol: The request protocol. api_url: The request URL. poc_payload: The request. request: The request sample. response: The response sample. param: The request parameters.	{ "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }

Examples

Success response

JSON format

{
  "TotalCount": 5,
  "RequestId": "9469646C-F2CC-5F0F-8401-C53***4F46",
  "Data": [
    {
      "AbnormalId": "7c1431f27ae7e9c8cc64095***68e",
      "Origin": "custom",
      "LastestTime": 1684252800,
      "FirstTime": 1701138088,
      "AbnromalStatus": "unresolved",
      "ApiFormat": "/api/login",
      "ApiTag": "SendMail",
      "DiscoverTime": 1684252800,
      "UserStatus": "Confirmed",
      "IgnoreTime": 1684252800,
      "Follow": 0,
      "MatchedHost": "a.aliyun.com",
      "Note": "已通知业务",
      "AbnormalEventNumber": 2,
      "AbnormalTag": "LackOfSpeedLimit",
      "AbnormalInfo": "{\n    \"data_type\": [\"1005\",\"1004\"],\n    \"rule\": {\n        \"parent\": \"RiskType_Permission\",\n        \"code\": \"Risk_UnauthSensitive\",\n        \"level\": \"high\",\n        \"origin\": \"default\",\n        \"name\": \"Risk_UnauthSensitive\"\n    }\n}",
      "ApiId": "09559c0d71ca2ffc996b81***836d8",
      "AbnormalLevel": "high",
      "LatestDiscoverTime": 1684252800,
      "Examples": [
        "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.