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

添加审计范围策略

功能介绍

添加审计范围策略

URI

POST /v1/{project_id}/audit/{instance_id}/rule/scopes

表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

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

db_ids

是

String

数据库ID，多个用英文逗号分隔，全部传[ALL]

db_names

是

String

数据库名称，多个用英文逗号分隔，全部传[全部数据库]

db_users

否

String

数据库账号，多个用英文逗号分隔

exception_ips

否

String

例外IP，多个用英文逗号分隔

rule_name

是

String

名称

source_ips

否

String

源IP，多个用英文逗号分隔

source_ports

否

String

源端口，多个用英文逗号分隔

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

状态

  • SUCCESS:成功

  • FAILED:失败

状态码：400

表5 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表6 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表7 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表8 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表9 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表10 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表11 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表12 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

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

{
  "db_ids" : "lQZpwJgB0g4pz3UTv74a",
  "db_names" : "MySQL",
  "rule_name" : "test"
}

响应示例

状态码：200

OK

{
  "status" : "SUCCESS"
}

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。