文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 审计规则-风险操作/ 添加风险规则
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

添加风险规则

功能介绍

添加风险规则

URI

POST /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 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

action

否

String

操作类型，多个用英文','分隔

affect_rows

是

Integer

影响行数

affect_symbol

是

String

影响行数操作符

  • GREATER: 大于

  • EQUAL: 等于

  • LESS: 小于

  • GREATER_EQUAL: 大于等于

  • LESS_EQUAL: 小于等于

  • NO_MATCH: 不等于

client_ips

否

String

客户端IP，多个用英文','分隔

db_ids

否

String

数据库ID，多个用英文','分隔

exception_ips

否

String

例外IP，IP内不做匹配，多个用英文','分隔

execution_symbol

是

String

执行时长操作符

  • GREATER: 大于

  • EQUAL: 等于

  • LESS: 小于

  • GREATER_EQUAL: 大于等于

  • LESS_EQUAL: 小于等于

  • NO_MATCH: 不等于

execution_time

是

Long

执行时长

ignore_case

否

Boolean

是否忽略大小写

risk_level

是

String

风险等级

  • LOW：低

  • MEDIUM：中

  • HIGH：高

  • NO_RISK：无

rule_name

是

String

规则名称

schemas

否

Array of SchemaBean objects

操作对象

status

是

String

状态

  • OFF：已关闭

  • ON：已开启
表4 SchemaBean

参数

是否必选

参数类型

描述

column

否

String

目标字段

schema

否

String

目标数据库

table

否

String

目标表

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

status

String

状态

  • SUCCESS:成功

  • FAILED:失败

状态码：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错误信息

状态码：401

表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错误信息

状态码：403

表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错误信息

状态码：500

表12 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表13 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

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

{
  "rule_name" : "test",
  "risk_level" : "LOW",
  "status" : "ON",
  "affect_rows" : 0,
  "affect_symbol" : "GREATER_EQUAL",
  "execution_symbol" : "GREATER_EQUAL",
  "execution_time" : 0,
  "db_ids" : "lQZpwJgB0g4pz3UTv74a",
  "client_ips" : "10.0.1.2,10.2.3.3",
  "schemas" : [ ],
  "ignore_case" : false,
  "action" : null,
  "exception_ips" : "10.0.1.2,10.2.3.3"
}

响应示例

状态码：200

OK

{
  "status" : "SUCCESS"
}

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。