DescribeAlertScene - Security Center - Alibaba Cloud Documentation Center

Queries the scenarios in which alerts can be whitelisted.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RoleType	integer	No	The type of the view. 0: the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise.	1
RoleFor	integer	No	The user ID of the member. An administrator can use this ID to switch to the member's perspective.	113091674488****
RegionId	string	No	The region where the data management center of Threat Analysis is deployed. You must select the region where your assets are located. Valid values: cn-hangzhou: your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: your assets are outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	BaseResponse<List>
Data	array<object>	The data returned.	123456
	object
AlertType	string	The display name of the alert type. The value varies based on the language of the environment.	unusual login
AlertTypeId	string	The ID of the alert type.	unusual login
AlertName	string	The display name of the alert. The value varies based on the language of the environment.	login_common_ip
AlertNameId	string	The ID of the alert name.	login_common_ip
AlertTile	string	The display title of the alert. The value varies based on the language of the environment.	unusual login-login_common_ip
AlertTileId	string	The ID of the alert title.	unusual login-login_common_ip
Targets	array<object>	The objects that can be added to the whitelist.	[{"Type": "host_uuid","Value": "441862da-a539-4cc0-a00d-473955826881","Values": ["441862da-a539-4cc0-a00d-473955826881"],"Name": "${aliyun.siem.entity.host_uuid}"}]
	object
Type	string	The field of the entity that can be added to the whitelist.	host_uuid
Name	string	The display name of the field of the entity that can be added to the whitelist.	HOST UUID
Value	string	The default right operand that is displayed for the whitelist rule.	441862da-a539-4cc0-a00d-47395582****
Values	array	The available right operands for the whitelist rule.	["441862da-a539-4cc0-a00d-473955826881"]
	string	The right operand.	[441862da-a539-4cc0-a00d-47395582****]
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 returned message.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****

Examples

Success response

JSON format

{
  "Data": [
    {
      "AlertType": "unusual login",
      "AlertTypeId": "unusual login",
      "AlertName": "login_common_ip",
      "AlertNameId": "login_common_ip",
      "AlertTile": "unusual login-login_common_ip",
      "AlertTileId": "unusual login-login_common_ip",
      "Targets": [
        {
          "Type": "host_uuid",
          "Name": "HOST UUID",
          "Value": "441862da-a539-4cc0-a00d-47395582****",
          "Values": [
            "[441862da-a539-4cc0-a00d-47395582****]"
          ]
        }
      ]
    }
  ],
  "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.