ListIncidents - Security Center - Alibaba Cloud Documentation Center

Retrieves a list of events.

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-sas:ListIncidents

list

*Incident

acs:yundun-sas::{#accountId}:incident/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region of the Data Management center for threat analysis. Select the region of the Data Management center based on the region where your assets are located. Valid values: cn-hangzhou: Your assets are in the Chinese mainland. ap-southeast-1: Your assets are in a region outside China.	cn-hangzhou
Lang	string	No	The language of the response messages. Valid values: zh (default): Chinese. en: English.	zh
IncidentName	string	No	The name of the event.	ECS unusual log in
IncidentUuids	array	No	A list of event UUIDs. Separate multiple UUIDs with commas.
	string	No	A list of event UUIDs. Separate multiple UUIDs with commas.	85ea4241-798f-4684-a876-65d4f0c3**,90ea4241-798f-4684-a876-65d4f0c3**
IncidentStatus	integer	No	The status of the event. Valid values: 0: open. 1: in progress. 5: handling failed. 10: handled.	0
ThreatLevel	array	No	The threat level. Valid values: 5: critical. 4: important. 3: medium. 2: low. 1: informational.
	string	No	The threat level. Valid values: 5: critical. 4: important. 3: medium. 2: low. 1: informational.	2
RelateAssetId	string	No	The ID of the asset associated with the event.	6c740667-80b2-476d-8924-2e706feb****
RelateEntityId	string	No	The ID of the entity associated with the event.	b920ed22259f5412099e97dfda96****
IncidentTags	string	No	The tags of the event.	[{\"data_source\":[\"sas\"]}]
AlertUuid	string	No	The alert ID.	sas_71e24437d2797ce8fc59692905a4****
StartTime	integer	No	The start time. This value is a UNIX timestamp in milliseconds.	1690102943000
EndTime	integer	No	The end time. This value is a UNIX timestamp in milliseconds.	1749090526055
OrderFieldName	string	No	The field to use for sorting. GmtModified: the time when the event was last updated (default). ThreatScore: the threat score.	GmtModified
OrderDirection	string	No	The sort order. Valid values: desc (default): descending. asc: ascending.	desc
PageNumber	integer	Yes	The page number for paging.	1
PageSize	integer	Yes	The number of entries to return on each page.	10
RoleFor	integer	No	The user ID of the member. An administrator can use this parameter to switch to the perspective of this member.	113091674488****
RoleType	integer	No	The type of the view. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts in the enterprise.	1
MaxResults	integer	No	The maximum number of entries to return.	10
NextToken	string	No	The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first query. If a NextToken value is returned in the previous query, include the value in your next query to retrieve the next page of results.	AAAAASLVeIxed4466E0LVmGkzwS6hJKd9DGVGMDRM6Lu****
Owners	array	No	The UID of the event owner.
	string	No	The UID of the event owner.	1234567890xxxxxx

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	6276D891-***-55B2-87B9-74D413F7**
Incidents	array<object>	The list of events.
	object	The event.
IncidentName	string	The name of the event.	ECS unusual log in
ThreatLevel	string	The threat level. Valid values: 5: critical. 4: important. 3: medium. 2: low. 1: informational.	2
IncidentStatus	integer	The status of the event. Valid values: 0: open. 1: in progress. 5: handling failed. 10: handled.	0
Owner	string	The UID of the event owner.	1234567890xxxxxx
CreateTime	integer	The time when the event was created.	1603248483000
UpdateTime	integer	The time when the event was last updated.	1603248483000
RelateAssetCount	integer	The number of assets associated with the event.	4
IncidentUuid	string	The UUID of the event.	dbb1d7211c9285c862aa89385098****
IncidentRemark	string	The remarks on the event.	remark
RelateAlertCount	integer	The number of alerts associated with the event.	3
IncidentTags	string	The tags of the event.	["sys:data_source:siem","sys:trigger_type:auto"]
DetectionRuleId	string	The ID of the detection rule.	dr-qo5ww6ux0uc28*****
PageNumber	integer	The page number for paging.	1
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of records.	57
MaxResults	integer	The maximum number of entries returned.	50
NextToken	string	The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first query. If a NextToken value is returned in the previous query, include the value in your next query to retrieve the next page of results.	AAAAAUqcj6VO4E3ECWIrFczs****

Examples

Success response

JSON format

{
  "RequestId": "6276D891-*****-55B2-87B9-74D413F7****",
  "Incidents": [
    {
      "IncidentName": "ECS unusual log in",
      "ThreatLevel": "2",
      "IncidentStatus": 0,
      "Owner": "1234567890xxxxxx",
      "CreateTime": 1603248483000,
      "UpdateTime": 1603248483000,
      "RelateAssetCount": 4,
      "IncidentUuid": "dbb1d7211c9285c862aa89385098****",
      "IncidentRemark": "remark",
      "RelateAlertCount": 3,
      "IncidentTags": "[\"sys:data_source:siem\",\"sys:trigger_type:auto\"]",
      "DetectionRuleId": "dr-qo5ww6ux0uc28*****"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 57,
  "MaxResults": 50,
  "NextToken": "AAAAAUqcj6VO4E3ECWIrFczs****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.