查询审计范围策略列表
功能介绍
查询审计范围策略列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/{instance_id}/dbss/audit/rule/scopes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID |
| instance_id | 是 | String | 实例ID。可在查询实例列表接口的ID字段获取。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | String | 偏移量 |
| limit | 否 | String | 查询记录数 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| scopes | Array of RuleScopeInfo objects | 审计范围规则列表 |
| total | Integer | 总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 是否全量审计策略，系统内置的全审计规则为TRUE，用户自定义的全审计规则为FALSE |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | Object | 错误信息返回体。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误请求返回的错误码。 |
| error_msg | String | 错误请求返回的错误信息。 |
状态码： 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | Object | 错误信息返回体。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误请求返回的错误码。 |
| error_msg | String | 错误请求返回的错误信息。 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | Object | 错误信息返回体。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 服务器内部错误 |
错误码
请参见错误码。
