DescribeHighlightInfo-阿里云帮助中心

Queries the highlight data for attack details. Based on the trace ID of a log blocked by basic protection, this operation traces the specific cause of the block. The highlight data indicates the content that triggered the interception by the basic protection module.

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

dcdn:DescribeHighlightInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the data to retrieve. 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 time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-04-10T02:43:34Z
TraceId	string	Yes	The trace ID of the log.	800e749616838513398137319e
Lang	string	Yes	The language of the response. Valid values: en_US (default): English. zh_CN: Chinese. Valid values: en_US : English. zh_CN : Chinese.	en_US

Response elements

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

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.