DescribeAlertScene - 获取告警加白规则场景列表_云安全中心(Security Center)-阿里云帮助中心

获取告警加白场景。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeAlertScene	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RoleType	integer	否	视图类型。 0：当前阿里云账号视图。 1：企业下所有账号的视图。	1
RoleFor	long	否	管理员切换成其他成员视角的用户 ID。	113091674488****
RegionId	string	否	威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值： cn-hangzhou：资产属于中国内地与中国香港 ap-southeast-1：资产属于海外地域	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	BaseResponse<List>
Data	array<object>	请求返回值。	123456
Data	object
AlertType	string	告警类型展示值，随中英文环境变化。	unusual login
AlertTypeId	string	告警类型标识。	unusual login
AlertName	string	告警名称展示值，随中英文环境变化。	login_common_ip
AlertNameId	string	告警名称标识。	login_common_ip
AlertTile	string	告警标题展示值，随中英文环境变化。	unusual login-login_common_ip
AlertTileId	string	告警标题标识。	unusual login-login_common_ip
Targets	array<object>	加白对象。	[{"Type": "host_uuid","Value": "441862da-a539-4cc0-a00d-473955826881","Values": ["441862da-a539-4cc0-a00d-473955826881"],"Name": "${aliyun.siem.entity.host_uuid}"}]
Target	object
Type	string	可以加白的实体属性字段。	host_uuid
Name	string	可以加白的实体属性字段展示名。	HOST UUID
Value	string	加白规则默认展示的右值。	441862da-a539-4cc0-a00d-47395582****
Values	array	加白规则可选的右值。
Value	string	右值。	[441862da-a539-4cc0-a00d-47395582****]
Success	boolean	请求是否成功。取值： true：成功 false：失败	true
Code	integer	请求状态码。	200
Message	string	请求返回消息。	success
RequestId	string	请求 ID。	9AAA9ED9-78F4-5021-86DC-D51C7511****

示例

正常返回示例

JSON格式

{
  "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****"
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	服务发生某些未知错误，请稍后再试

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-17	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情