Query Similar Security Alert Events via API - Security Center - Alibaba Cloud - Security Center

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	1.2.XX.XX
SecurityEventId	integer	Yes	The ID of the alert event.	14323
SimilarEventScenarioCode	string	No	The code of the alerting event that has the same type or rule hits.	default
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Different requests should use different tokens. The token supports only ASCII characters and cannot exceed 64 characters in length.
ResourceDirectoryAccountId	integer	No
		No	Specifies whether to perform only a dry run of the request. Valid values: true: performs only a dry run without executing the actual operation. false: performs the actual operation. Default value: false.

Response elements

Element	Type	Description	Example
	object
CreateSimilarSecurityEventsQueryTaskResponse	object	The response for creating a task to query similar alert events.
Status	string	The task status. Valid values: New: New. RetrievingData: Data is being retrieved. DataRetrieved: Data is retrieved. Processing: The task is being processed. Success: The task is successful. Failed: The task failed. PartialFailed: The task partially failed.	New
TaskId	integer	The ID of the task.	2915
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	5861EE3E-F0B3-48B8-A5DC-A5080BFBE052

Examples

Success response

JSON format

{
  "CreateSimilarSecurityEventsQueryTaskResponse": {
    "Status": "New",
    "TaskId": 2915
  },
  "RequestId": "5861EE3E-F0B3-48B8-A5DC-A5080BFBE052"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SecurityEventNotExists	Security event not exists.
400	NoPermission	no permission
400	IllegalParam	Illegal param
400	RdCheckNoPermission	Resource directory account verification has no permission.
400	IdempotentParameterMismatch	相同的 ClientToken 被用于不同的请求参数。
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
409	IdempotentRequestInProgress	使用相同 ClientToken 的请求正在处理中。

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.