文档

DescribeWhiteRuleList - 获取告警加白规则列表

更新时间:

获取告警加白规则列表。

调试

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

授权信息

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

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

请求参数

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

告警类型。

scan
AlertNamestring

告警名称。

Try SNMP weak password
IncidentUuidstring

事件全局唯一 UUID。

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

列表当前页号, 大于等于 1。

1
PageSizeinteger

列表每页条数, 最大不超过 100。

10
RoleTypeinteger

视图类型。

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

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

113091674488****
RegionIdstring

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

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

返回参数

名称类型描述示例值
object

PageResponse<List>

Successboolean

请求是否成功。取值:

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

请求状态码。

200
Messagestring

请求返回消息。

success
RequestIdstring

请求 ID。

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

请求返回值。

PageInfoobject

分页记录。

CurrentPageinteger

列表当前页号。

1
PageSizeinteger

每页返回记录数。

10
TotalCountlong

记录总数。

100
ResponseDataarray<object>

详细数据。

object
Idlong

加白规则唯一 ID。

123456789
GmtCreatestring

创建时间。

2021-01-06 16:37:29
GmtModifiedstring

修改时间。

2021-01-06 16:37:29
Aliuidlong

开通威胁分析的阿里云账号 ID。

127608589417****
SubAliuidlong

创建规则的阿里云账号 ID。

176555323***
AlertTypestring

告警类型。

scan
AlertTypeIdstring

告警类型标识。

scan
AlertNamestring

告警名称。

Try SNMP weak password
AlertNameIdstring

告警名称标识。

Try SNMP weak password
Statusinteger

规则启用状态。 取值:

  • 1:开启
  • 0:关闭
1
IncidentUuidstring

事件全局唯一 UUID。

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

告警 UUID。

sas_71e24437d2797ce8fc59692905a4****
Expressionobject

规则集 json 数组格式。

Logicstring

条件逻辑关系。

(1&2)|(3&4)
Conditionsarray<object>

规则表达式数组。

object

规则表达式数组。

ItemIdinteger

条件 ID。

1
Operatorstring

分派规则条件聚合方式。

  • =:等于
  • <>:不等于
  • in:包含
  • not in:不包含
  • REGEXP:匹配正则
  • NOT REGEXP:正则不匹配
REGEXP
IsNotboolean

对结果是否取反。 取值:

  • true:取反
  • false:不取反
false
Leftobject

条件左值。

Valuestring

左值变量名称。

ip
IsVarboolean

是否是变量。

  • true:变量
  • false:常量
true
Typestring

是否是常量。取值:

  • true:是
  • false:否
false
Modifierstring

备注信息。

length
ModifierParamobject

备注信息键值对。

any

备注信息键值对。

{"tage":"description"}
Rightobject

右值对象。

Valuestring

右值。

12345
IsVarboolean

指定右变量值是常量,还是运行时变量(从运行时上下文中获取具体值)。

  • true:运行时变量
  • false:常量
false
Typestring

数据类型。

String
Modifierstring

备注信息。

length
ModifierParamobject

备注信息键值对。

any

备注信息键值对。

{"tage":"description"}

示例

正常返回示例

JSON格式

{
  "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",
        "Aliuid": 0,
        "SubAliuid": 0,
        "AlertType": "scan",
        "AlertTypeId": "scan",
        "AlertName": "Try SNMP weak password",
        "AlertNameId": "Try SNMP weak password",
        "Status": 1,
        "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
        "AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
        "Expression": {
          "Logic": "(1&2)|(3&4)",
          "Conditions": [
            {
              "ItemId": 1,
              "Operator": "REGEXP",
              "IsNot": false,
              "Left": {
                "Value": "ip",
                "IsVar": true,
                "Type": "false",
                "Modifier": "length",
                "ModifierParam": {
                  "key": "{\"tage\":\"description\"}"
                }
              },
              "Right": {
                "Value": "12345",
                "IsVar": false,
                "Type": "String",
                "Modifier": "length",
                "ModifierParam": {
                  "key": "{\"tage\":\"description\"}"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

错误码

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

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

变更历史

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