DescribeEventDispose - Security Center - Alibaba Cloud Documentation Center

Queries the policy handling history for an event.

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:DescribeEventDispose

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IncidentUuid	string	No	The globally unique UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
CurrentPage	integer	No	The number of the page to return. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 500.	10
RoleType	integer	No	The view type. 0: The view of the current Alibaba Cloud account. 1: The view of all accounts that belong to the enterprise.	1
RoleFor	integer	No	The user ID of the member. An administrator can use this parameter to switch to the perspective of a member.	113091674488****
RegionId	string	No	The region where the Data Management center of Threat Analysis is located. Select the region based on the region where your assets are deployed. Valid values: cn-hangzhou: Your assets are deployed in the Chinese mainland or China (Hong Kong). ap-southeast-1: Your assets are deployed in regions outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	BaseResponse
Data	object	The data returned.	123456
Status	integer	The status of the event. Valid values: 0: unhandled 1: handling 5: failed 10: handled	0
Remark	string	The remarks on the event.	dealed
EventDispose	array	The JSON object of the event handling configuration.	{ playbookName: "使用安全组封禁入方向IP", sophonTaskId: "400442a5-4f98-45ed-97db-5ab117eb0b8f", … }
	any	The JSON object of the event handling configuration.	{ playbookName: "WafBlockIP", sophonTaskId: "400442a5-4f98-45ed-97db-5ab117eb0b8f", … }
ReceiverInfo	object	The JSON object of the alert recipient configuration.
Id	integer	The record ID of the recipient for the event handling result.	123
GmtCreate	string	The time when the record was created.	2021-01-06 16:37:29
GmtModified	string	The time when the record was last modified.	2021-01-06 16:37:29
IncidentUuid	string	The globally unique UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
MessageTitle	string	The title of the message.	siem event dealed message
Receiver	string	The contact information of the recipient.	138xxxxxx
Channel	string	The channel to send the notification. Valid values: message: text message mail: email	message
Status	integer	The sending status of the notification. Valid values: 0: not sent 1: sent	1
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	integer	The status code of the request.	200
Message	string	The message returned for the request.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****

Examples

Success response

JSON format

{
  "Data": {
    "Status": 0,
    "Remark": "dealed",
    "EventDispose": [
      "{ playbookName: \"WafBlockIP\", sophonTaskId: \"400442a5-4f98-45ed-97db-5ab117eb0b8f\", … }"
    ],
    "ReceiverInfo": {
      "Id": 123,
      "GmtCreate": "2021-01-06 16:37:29",
      "GmtModified": "2021-01-06 16:37:29",
      "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
      "MessageTitle": "siem event dealed message",
      "Receiver": "138xxxxxx",
      "Channel": "message",
      "Status": 1
    }
  },
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.