All Products
Search
Document Center

Application Real-Time Monitoring Service:ListInsightsEvents

Last Updated:Nov 05, 2024

Queries the abnormal Insights events within a specified period of time.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetAlertnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
PidstringNo

The ID of the application.

aokcdqn3ly@a195c6d6421****
StartTimestringYes

The start of the time range to query. The value is a timestamp.

1595174400000
EndTimestringYes

The end of the time range to query. The value is a timestamp.

1480607940000
InsightsTypesstringNo

The types of the events that you want to query. Separate multiple event types with commas (,). If you do not specify this parameter, all events are queried.

  • errorIncrease: API error-rate spike events. Examples: HTTP API error-rate spike events and Dubbo API error-rate spike events.
  • topErrorIncrease: the top five API error-rate spike events with the highest traffic.
  • topRtIncrease: API response-time spike events. Examples: HTTP API response-time spike events and Dubbo API response-time spike events.
  • rtIncrease: the top five API response-time spike events with the highest traffic.
errorIncrease,topErrorIncrease,topExceptionIncrease,topRtIncrease,rtIncrease

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6F1174DC-6085-5353-AAE7-D4ADCD******
InsightsEventsarray<object>

The details of the event.

ProblemInfosobject
Titlestring

The title of the event.

Average response-time spikes of application services
Descstring

The description of the alert event.

The overall response time of the \[HTTP] service of the application \[sd] spikes at \[2022-07-27 10:57:00]
Typestring

The type of the event.

rtIncrease
Pidstring

The ID of the application associated with the event.

dsv9zcel92@7da413b******
Levelstring

The severity of the event.

P3
Datelong

The time when the event occurred. The value is a timestamp.

1658890560
ProblemIdstring

The problem identifier.

erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******

Examples

Sample success responses

JSONformat

{
  "RequestId": "6F1174DC-6085-5353-AAE7-D4ADCD******",
  "InsightsEvents": [
    {
      "Title": "Average response-time spikes of application services\n",
      "Desc": "The overall response time of the \\[HTTP] service of the application \\[sd] spikes at \\[2022-07-27 10:57:00]\n",
      "Type": "rtIncrease",
      "Pid": "dsv9zcel92@7da413b******",
      "Level": "P3",
      "Date": 1658890560,
      "ProblemId": "erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-19The response structure of the API has changedView Change Details