文档

DescribeAlertSceneByEvent - 获取告警加白场景与加白对象列表

更新时间:

获取告警加白场景与加白对象列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
IncidentUuidstring

事件 ID。

85ea4241-798f-4684-a876-65d4f0c3****
RoleTypeinteger

视图类型。

  • 0:当前阿里云账号视图。
  • 1:企业下所有账号的视图。
1
RoleForlong

管理员切换成其他成员视角的用户 ID。

113091674488****
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港
  • ap-southeast-1:资产属于海外地域
cn-hangzhou

返回参数

名称类型描述示例值
object

BaseResponse<List>

Dataarray<object>

请求返回值。

123456
object
AlertTypestring

告警类型展示值,随中英文环境变化。

Unusual Logon
AlertTypeIdstring

告警类型标识。

Unusual Logon
AlertNamestring

告警名称展示值,随中英文环境变化。

login_common_ip
AlertNameIdstring

告警名称标识。

login_common_ip
AlertTilestring

告警标题展示值,随中英文环境变化。

Unusual Logon-login_common_ip
AlertTileIdstring

告警标题标识。

Unusual Logon-login_common_ip
Targetsarray<object>

加白对象。

[{"Type": "host_uuid","Value": "441862da-a539-4cc0-a00d-473955826881","Values": ["441862da-a539-4cc0-a00d-473955826881"],"Name": "${aliyun.siem.entity.host_uuid}"}]
object
Typestring

可以加白的实体属性字段。

host_uuid
Namestring

可以加白的实体属性字段展示名。

host uuid
Valuestring

加白规则默认展示的右值。

441862da-a539-4cc0-a00d-47395582****
Valuesarray

加白规则可选的右值。

string

右值。

[441862da-a539-4cc0-a00d-47395582****]
Successboolean

请求是否成功。取值:

  • true:成功
  • false:失败
true
Codeinteger

请求状态码。

200
Messagestring

请求返回消息。

success
RequestIdstring

请求 ID。

9AAA9ED9-78F4-5021-86DC-D51C7511****

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "AlertType": "Unusual Logon",
      "AlertTypeId": "Unusual Logon",
      "AlertName": "login_common_ip",
      "AlertNameId": "login_common_ip",
      "AlertTile": "Unusual Logon-login_common_ip",
      "AlertTileId": "Unusual Logon-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错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试

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

变更历史

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