文档首页/ 数据库安全服务 DBSS/ API参考 (巴黎、阿姆斯特丹区域) / API/ 实例侧规则接口/ 查询审计范围策略列表
更新时间：2024-01-15 GMT+08:00
查看PDF
分享

查询审计范围策略列表

功能介绍

查询审计范围策略列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

偏移量

limit

否

String

查询记录数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

scopes

Array of RuleScopeInfo objects

审计范围规则列表

total

Integer

总数
表5 RuleScopeInfo

参数

参数类型

描述

id

String

审计范围规则ID

name

String

审计范围名称

action

String

审计范围动作

status

String

审计范围规则状态

exception_ips

String

审计范围例外IP

source_ips

String

审计范围规则源IP

source_ports

String

审计范围源端口

db_ids

String

数据库ID

db_names

String

数据库名称

db_users

String

数据库用户

all_audit

Boolean

是否全审计

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

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

响应示例

状态码： 200

成功

{
  "scopes" : [ {
    "id" : "zX4W2ngBo47GiyUSBuNs",
    "name" : "全审计规则",
    "action" : "",
    "status" : "ON",
    "exception_ips" : "",
    "source_ips" : "",
    "source_ports" : "",
    "db_ids" : "",
    "db_names" : "",
    "db_users" : "",
    "all_audit" : true
  } ],
  "total" : 1
}

状态码： 400

请求参数错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码： 500

服务器内部错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题： 实例侧规则接口