DescribeHighlightInfo - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the highlighted data of attack details. You can query the reasons for which requests are blocked based on TraceIDs in logs of requests that are blocked by Basic Web Protection. The highlighted data matches the content blocked by the basic web protection module.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-02-19T16:00:00Z
EndTime	string	No	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-04-10T02:43:34Z
TraceId	string	Yes	The ID of the trace.	800e749616838513398137319e
Lang	string	Yes	The access language. Valid values: en-US (default): English. zh-CN: Chinese. Enumeration Value: zh_CN en_US	en_US

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
DataModule	array<object>	The data model of the highlighted data.
DataItem	object
Key	string	The type of the highlighted data.	URL
Hit	string	The highlighted data.	[\"data:image/php;base64\"]
Raw	string	The complete data.	data:image/php;base64,PD9waHAXXXXXXanVzdHR0dHXXXXXB0ZXN0Ijs/Pg==

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DataModule": [
    {
      "Key": "URL",
      "Hit": "[\\\"data:image/php;base64\\\"]",
      "Raw": "data:image/php;base64,PD9waHAXXXXXXanVzdHR0dHXXXXXB0ZXN0Ijs/Pg=="
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.
500	InternalError	An internal error occurred; please try again later.	An internal error occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, visit the Service error codes.