更新时间:2025-09-10 GMT+08:00

查询风险规则策略

功能介绍

查询风险规则策略

URI

GET /v1/{project_id}/audit/{instance_id}/rule/risk

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制

不涉及

取值范围

以IAM服务接口返回值为准,字符长度32-64。

默认取值

不涉及

instance_id

String

参数解释

实例ID。可通过查询实例列表接口ID字段获取

约束限制

不涉及

取值范围

以查询实例列表接口值为准,字符长度32-64。

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

name

String

风险名称

risk_levels

String

参数解释

风险级别

约束限制

以取值范围为准

取值范围

  • LOW:低风险

  • MEDIUM:中风险

  • HIGH:高风险

  • NO_RISK:无风险

默认取值

不涉及

support_db_classify_rule

Boolean

参数解释

实例前端是否支持按数据库类型展示风险规则

约束限制

以取值范围为准

取值范围

  • true: 支持

  • false: 不支持

默认取值

false: 不支持

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及

取值范围

IAM服务查询用户Token接口为准

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

rules

Array of rules objects

风险规则列表

total

Integer

总数

customize_total

Integer

自定义规则总数

表5 rules

参数

参数类型

描述

id

String

风险规则ID

name

String

风险规则名称

type

String

风险规则类型

feature

String

风险规则特征

status

String

风险规则状态。

  • ON: 开启

  • OFF: 关闭

rank

Integer

风险规则优先级。数字越小优先级越高。

risk_level

String

风险级别

  • LOW

  • MEDIUM

  • HIGH

  • NO_RISK

rule_type

String

规则类型

状态码:400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码:403

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码:500

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v1/{project_id}/audit/{instance_id}/rule/risk

响应示例

状态码:200

成功

{
  "rules" : [ {
    "id" : "xX4W2ngBo47GiyUSBeOy",
    "name" : "Database_drag_detection",
    "type" : "OPERATE",
    "feature" : "CLIENT[Any]OPERATE[[SELECT]OBJECT[Any]",
    "status" : "ON",
    "rank" : -1,
    "risk_level" : "HIGH"
  }, {
    "id" : "xn4W2ngBo47GiyUSBeP4",
    "name" : "Database_Slow_SQL_Detection",
    "type" : "OPERATE",
    "feature" : "CLIENT[Any]OPERATE[[SELECT]OBJECT[Any]",
    "status" : "ON",
    "rank" : -2,
    "risk_level" : "LOW"
  } ],
  "total" : 2
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码