DescribeAlertsWithEvent-阿里云帮助中心

Retrieves alerts associated with a specific 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:DescribeAlertsWithEvent

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IncidentUuid	string	No	The incident ID.	85ea4241-798f-4684-a876-65d4f0c3****
Level	array	No	The threat level. The value is a JSON array. Valid values: `serious`: high `suspicious`: medium `remind`: low	["serious","suspicious","remind"]
	string	No	The threat level. The value is a JSON array. Valid values: `serious`: high `suspicious`: medium `remind`: low	["remind","serious"]
AlertTitle	string	No	The title of the alert.	Scan-Try SNMP weak password
AlertType	string	No	The type of the alert.	Scan
AlertName	string	No	The name of the alert.	Try SNMP weak password
AssetName	string	No	The name of the asset.	hostname-****
AssetId	string	No	The ID of the asset.	09414e9ebaa9c19b84d851abb91d****
EntityName	string	No	The name of the entity.	launch-advisor-*****
EntityId	string	No	The ID of the entity.	21034e803f492b926cea9e5beab4****
SubUserId	integer	No	The ID of the account that is associated with the alert.	176555323***
Source	string	No	The data source of the alert.	sas
IsDefend	string	No	Indicates whether the attack is defended. Valid values: `0`: detected `1`: blocked	1
StartTime	integer	No	The start of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1577808000000
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1577808000000
CurrentPage	integer	Yes	The page number. Pages start from page 1.	1
PageSize	integer	Yes	The number of entries per page. Maximum value: 100.	10
RoleType	integer	No	The entity of the alert. Valid values: `0`: the current Alibaba Cloud account. `1`: all members in the resource directory.	1
RoleFor	integer	No	The ID of the member in the resource directory.	113091674488****
RegionId	string	No	The region in which the data management center of Threat Analysis resides. You can determine the region based on the region in which your assets reside. Valid values: `cn-hangzhou`: Your assets reside in the Chinese mainland or Hong Kong (China). `ap-southeast-1`: Your assets reside in regions outside the Chinese mainland.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	A paginated response that contains a list of alerts.
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code of the request.	200
Message	string	The response message.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	The response payload.	123456
PageInfo	object	The pagination information.
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	100
ResponseData	array<object>	The details of the alerts.
	array<object>	The details of the alert.
Id	integer	The unique ID of the alert.	123456789
GmtCreate	string	The time when the alert was created.	2021-01-06 16:37:29
GmtModified	string	The time when the alert was last updated.	2021-01-06 16:37:29
MainUserId	integer	The ID of the main account associated with the alert.	127608589417****
IncidentUuid	string	The universally unique identifier (UUID) of the event.	85ea4241-798f-4684-a876-65d4f0c3****
AlertUuid	string	The UUID of the alert.	sas_71e24437d2797ce8fc59692905a4****
LogTime	string	The time when the alert was recorded.	2021-01-06 16:37:29
AlertSrcProd	string	The source product of the alert.	sas
AlertTitle	string	The title of the alert.	Scan-Try SNMP weak password
AlertTitleEn	string	The English title of the alert.	Scan-Try SNMP weak password
AlertType	string	The type of the alert.	Scan
AlertTypeEn	string	The English type of the alert.	Scan
AlertTypeCode	string	The Medusa code of the alert type.	security_event_config.event_name.webshellName
AlertName	string	The name of the alert.	Try SNMP weak password
AlertNameEn	string	The English name of the alert.	Try SNMP weak password
AlertNameCode	string	The Medusa code of the alert name.	security_event_config.event_name.webshell
AlertLevel	string	The threat level of the alert. Valid values: `serious`: high `suspicious`: medium `remind`: low	remind
AssetList	string	A JSON-formatted string that lists the assets associated with the alert.	[ { "is_main_asset": "1", "asset_name": "47.245.", "port": "22", "ip": "47.245.", "asset_type": "ip", "location": "ap-southeast-1", "asset_id": "47.245.*", "net_connect_dir": "in" } ]
OccurTime	string	The time when the alert occurred.	2021-01-06 16:37:29
StartTime	string	The time when the alert first occurred.	2021-01-06 16:37:29
EndTime	string	The end time of the alert.	2021-01-06 16:37:29
AlertSrcProdModule	string	The submodule of the source product.	waf
AlertDesc	string	The description of the alert.	The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.
AlertDescEn	string	The English description of the alert.	The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.
AlertDescCode	string	The Medusa code of the alert description.	security_event_config.event_name.webshell
AlertDetail	string	A JSON-formatted string that contains the alert details.	{"main_user_id": "165295629792***";"log_uuid_count": "99";"attack_ip": "21.92..*"}
LogUuid	string	The UUID of the alert log.	cfw_d12e285a-a042-4d7e-be89-f8a795ef****
EntityList	string	A JSON-formatted string that lists the entities involved in the alert.	[{"entity_user_id":"198921674491**","entity_account_id":"N/A","entity_uuid":"6245f979d5dd9ef8dd19bdc72228","entity_type":"host","entity_name":"zhh-test-20240409","is_comprised":"1","os_type":"linux","entity_id":"a88f44dd-b8d4-4ded-831c-77a4835","host_uuid":"a88f44dd-b8d4-4ded-831c-77a4835","host_name":"zhh-test-2024**"}]
AttCk	string	The ATT&CK tag.	T1595.002 Vulnerability Scanning
SubUserId	integer	The ID of the sub-account that generated the alert.	176555323***
SubUserName	string	The name of the sub-account that generated the alert.	176555323***
CloudCode	string	The cloud service provider. Valid values: `aliyun`: Alibaba Cloud `qcloud`: Tencent Cloud `hcloud`: Huawei Cloud	aliyun
IsDefend	string	Indicates whether the attack was blocked. Valid values: `0`: detected `1`: blocked	1
AlertInfoList	array<object>	A list of objects that contain detailed alert attributes.	aliyun
	object	An object that contains the attributes of a specific alert detail.
Key	string	The key of the alert attribute.	suspicious.wbd.wb.trojanpath
KeyName	string	The display name of the alert attribute.	Trojan Path
Values	string	The value of the alert attribute.	/root/test33.php
ExtendContent	string	A JSON-formatted string that contains extended information about the alert.	{"main_user_id": "165295629792**";"log_uuid_count": "99**"}
ProductId	string	The cloud service ID.	alibaba_cloud_sas
VendorId	string	The cloud service provider. Valid values: `aliyun`: Alibaba Cloud `qcloud`: Tencent Cloud `hcloud`: Huawei Cloud	aliyun
DetectionRuleId	string	The ID of the detection rule.	dr-48zs4tk7qfd4rjd9****
InvestigationReport	string	A JSON-formatted string that contains the investigation report for the alert.	{"agent_attack_confidence": 90, "agent_judgement_category": "false_positive", "reason": "The command line contains 'mediacenter' which is a normal startup behavior of Lark (Feishu) client, and the process path is in the standard user installation directory.", "start_time": 1774929064, "end_time": 1774929071}

Examples

Success response

JSON format

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 10,
      "TotalCount": 100
    },
    "ResponseData": [
      {
        "Id": 123456789,
        "GmtCreate": "2021-01-06 16:37:29",
        "GmtModified": "2021-01-06 16:37:29",
        "MainUserId": 0,
        "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
        "AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
        "LogTime": "2021-01-06 16:37:29",
        "AlertSrcProd": "sas",
        "AlertTitle": "Scan-Try SNMP weak password",
        "AlertTitleEn": "Scan-Try SNMP weak password",
        "AlertType": "Scan",
        "AlertTypeEn": "Scan",
        "AlertTypeCode": "security_event_config.event_name.webshellName",
        "AlertName": "Try SNMP weak password",
        "AlertNameEn": "Try SNMP weak password",
        "AlertNameCode": "security_event_config.event_name.webshell",
        "AlertLevel": "remind",
        "AssetList": "[\n      {\n            \"is_main_asset\": \"1\",\n            \"asset_name\": \"47.245.*\",\n            \"port\": \"22\",\n            \"ip\": \"47.245.*\",\n            \"asset_type\": \"ip\",\n            \"location\": \"ap-southeast-1\",\n            \"asset_id\": \"47.245.*\",\n            \"net_connect_dir\": \"in\"\n      }\n]",
        "OccurTime": "2021-01-06 16:37:29",
        "StartTime": "2021-01-06 16:37:29",
        "EndTime": "2021-01-06 16:37:29",
        "AlertSrcProdModule": "waf",
        "AlertDesc": "The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.",
        "AlertDescEn": "The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.",
        "AlertDescCode": "security_event_config.event_name.webshell\n",
        "AlertDetail": "{\"main_user_id\": \"165295629792****\";\"log_uuid_count\": \"99\";\"attack_ip\": \"21.92.*.*\"}",
        "LogUuid": "cfw_d12e285a-a042-4d7e-be89-f8a795ef****",
        "EntityList": "[{"entity_user_id":"198921674491****","entity_account_id":"N/A","entity_uuid":"6245f979d5dd9ef8dd19bdc72228****","entity_type":"host","entity_name":"zhh-test-20240409","is_comprised":"1","os_type":"linux","entity_id":"a88f44dd-b8d4-4ded-831c-77a4835****","host_uuid":"a88f44dd-b8d4-4ded-831c-77a4835****","host_name":"zhh-test-2024****"}]",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "SubUserId": 0,
        "SubUserName": "176555323***",
        "CloudCode": "aliyun",
        "IsDefend": "1",
        "AlertInfoList": [
          {
            "Key": "suspicious.wbd.wb.trojanpath",
            "KeyName": "Trojan Path\n",
            "Values": "/root/test33.php"
          }
        ],
        "ExtendContent": "{\"main_user_id\": \"165295629792****\";\"log_uuid_count\": \"99****\"}",
        "ProductId": "alibaba_cloud_sas",
        "VendorId": "aliyun",
        "DetectionRuleId": "dr-48zs4tk7qfd4rjd9****",
        "InvestigationReport": "{\"agent_attack_confidence\": 90, \"agent_judgement_category\": \"false_positive\", \"reason\": \"The command line contains 'mediacenter' which is a normal startup behavior of Lark (Feishu) client, and the process path is in the standard user installation directory.\", \"start_time\": 1774929064, \"end_time\": 1774929071}"
      }
    ]
  }
}

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.