DescribeAlertsWithEntity - Security Center - Alibaba Cloud Documentation Center

Queries for alerts that are associated with an entity.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IncidentUuid	string	No	The globally unique ID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
SophonTaskId	string	No	The ID of the Security Orchestration, Automation, and Response (SOAR) handling policy.	577bbf90-a770-44a7-8154-586aa2d318fa
EntityId	integer	No	The ID of the entity.	123456789
EntityUuid	string	No	The ID of the entity.	123456789
StartTime	integer	No	The start time of the query. The unit is milliseconds.	1577808000000
EndTime	integer	No	The end time of the query. The unit is milliseconds.	1577808000000
CurrentPage	integer	Yes	The number of the page to return. The value must be greater than or equal to 1.	1
PageSize	integer	Yes	The number of entries to return on each page. The maximum value is 100.	10
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 that are managed by your enterprise.	1
RoleFor	integer	No	The user ID of the member to which the administrator switches.	113091674488****
RegionId	string	No	The region of the data management center for threat analysis. Select a region based on the location of your assets. Valid values: cn-hangzhou: your assets are in the Chinese mainland and China (Hong Kong). ap-southeast-1: your assets are outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	PageResponse<List<AlertDetail>>
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 message returned for the request.	success
RequestId	string	The ID of the request.	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	The data returned.	123456
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	100
ResponseData	array<object>	The detailed data.
	array<object>	The detailed data.
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 Alibaba Cloud account that is used for threat analysis.	127608589417****
IncidentUuid	string	The globally unique 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 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. Valid values: serious: high suspicious: medium remind: low	remind
AssetList	string	The list of assets.	[ { "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 time when the alert ended.	2021-01-06 16:37:29
AlertSrcProdModule	string	The submodule of the alert source.	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	The details of the alert.	{"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	The details of the entity. The entity is standardized and indexed.	[{"entity_uuid":"55f0c0654d7e79b035a5168fcb4**","entity_type":"cloud_account","account_id":"15176874502","main_user_id":"15176874502","cloud_code":"alibaba_cloud","is_asset":1,"entity_id":"151768745029**"}]
AttCk	string	The ATT&CK tag.	T1595.002 Vulnerability Scanning
SubUserId	integer	The ID of the Alibaba Cloud account that generated the alert.	176555323***
SubUserName	string	The name of the Alibaba Cloud account that generated the alert.	176555323***
IsDefend	string	Indicates whether the threat is defended. Valid values: 0: detected 1: blocked	1
AlertInfoList	array<object>	The detailed information about the alert.	aliyun
	object	The detailed information about the alert.
Key	string	The key of the alert property.	suspicious.wbd.wb.trojanpath
KeyName	string	The name of the detailed alert data.	Trojan Path
Values	string	The value of the detailed alert data.	/root/test33.php
CloudCode	string	The cloud service provider. Valid values: aliyun: Alibaba Cloud qcloud: Tencent Cloud hcloud: Huawei Cloud	aliyun
ProductId	string	The product 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****

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_uuid\":\"55f0c0654d7e79b035a5168fcb4****\",\"entity_type\":\"cloud_account\",\"account_id\":\"15176874502****\",\"main_user_id\":\"15176874502****\",\"cloud_code\":\"alibaba_cloud\",\"is_asset\":1,\"entity_id\":\"151768745029****\"}]",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "SubUserId": 0,
        "SubUserName": "176555323***",
        "IsDefend": "1",
        "AlertInfoList": [
          {
            "Key": "suspicious.wbd.wb.trojanpath",
            "KeyName": "Trojan Path\n",
            "Values": "/root/test33.php"
          }
        ],
        "CloudCode": "aliyun",
        "ProductId": "alibaba_cloud_sas",
        "VendorId": "aliyun",
        "DetectionRuleId": "dr-48zs4tk7qfd4rjd9****"
      }
    ]
  }
}

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.