# 查询审计SQL语句\[待下线\] - ListAuditSqls #### 功能介绍 查询审计SQL语句 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=ListAuditSqls)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI POST /v1/{project_id}/{instance_id}/audit/sqls 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time | 是 | [time] object | 查询时间范围 | | risk_levels | 否 | String | 风险级别 - HIGH：高 - MEDIUM：中 - LOW：低 - NO_RISK：无 | | client_ip | 否 | String | 客户端IP | | client_name | 否 | String | 客户端名称 | | db_ip | 否 | String | 数据库IP | | db_user | 否 | String | 数据库用户 | | query_type | 否 | String | 查询类型 - LOGIN：LOGIN - CREATE_TABLE：CREATE TABLE - CREATE_TABLESPACE：CREATE TABLESPACE - DROP_TABLE：DROP TABLE - DROP_TABLESPACE：DROP TABLESPACE - DELETE：DELETE - INSERT：INSERT - INSERT_SELECT：INSERT SELECT - SELECT：SELECT - SELECT_FOR_UPDATE：SELECT FOR UPDATE - UPDATE：UPDATE - CREATE_USER：CREATE USER - DROP_USER：DROP USER - GRANT：GRANT - OPERATE：OPERATE - ALL: ALL | | rule_name | 否 | String | 规则名称 | | sql_statement | 否 | String | sql语句 | | sql_response | 否 | String | 响应结果 - SUCCESS：成功 - FAILED：失败 | | page | 是 | Integer | 页码 | | size | 是 | Integer | 条数 | | time_order | 是 | String | 时间顺序 - DESC：降序 - ASC：升序 | 表4time | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time_range | 否 | String | 时间范围。和start_time，end_time不能同时使用，同时传该参数优先级更高。 - HALF_HOUR：半小时 - HOUR：1小时 - THREE_HOUR：3小时 - TWELVE_HOUR：12小时 - DAY：1天 - WEEK：一周 - MONTH：一个月 | | start_time | 否 | String | 开始时间，必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间 | | end_time | 否 | String | 结束时间，必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总数 | | count | Integer | 总数 | | sqls | Array of [sqls] objects | sql语句列表 | 表6sqls | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sql | [sql] object | sql信息 | 表7sql | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | ID | | sql_statement | String | sql语句 | | client_ip | String | 客户端IP | | client_name | String | 客户端名称 | | db_ip | String | 数据库IP | | db_user | String | 数据库用户名 | | query_type | String | 查询类型 - LOGIN：LOGIN - CREATE_TABLE：CREATE TABLE - CREATE_TABLESPACE：CREATE TABLESPACE - DROP_TABLE：DROP TABLE - DROP_TABLESPACE：DROP TABLESPACE - DELETE：DELETE - INSERT：INSERT - INSERT_SELECT：INSERT SELECT - SELECT：SELECT - SELECT_FOR_UPDATE：SELECT FOR UPDATE - UPDATE：UPDATE - CREATE_USER：CREATE USER - DROP_USER：DROP USER - GRANT：GRANT - OPERATE：OPERATE - ALL：ALL | | operated_obj_info | Array of [operated_obj_info] objects | 操作对象列表 | | rule_name | String | 规则名称 | | risk_level | String | 风险级别 - HIGH：高 - MEDIUM：中 - LOW：低 - NO_RISK：无风险 | | start_time | String | 审计开始时间 | | sql_response | String | 响应结果 - SUCCESS：成功 - FAILED：失败 | | db_instance | String | 数据库实例 | 表8operated_obj_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column_name | String | 列名 | | object_type | String | 操作对象类型 - VARIABLE：变量 - ""：空 | | schema_name | String | schema名称 | | sql_type | String | sql类型 - LOGIN：LOGIN - CREATE_TABLE：CREATE TABLE - CREATE_TABLESPACE：CREATE TABLESPACE - DROP_TABLE：DROP TABLE - DROP_TABLESPACE：DROP TABLESPACE - DELETE：DELETE - INSERT：INSERT - INSERT_SELECT：INSERT SELECT - SELECT：SELECT - SELECT_FOR_UPDATE：SELECT FOR UPDATE - UPDATE：UPDATE - CREATE_USER：CREATE USER - DROP_USER：DROP USER - GRANT：GRANT - OPERATE：OPERATE - ALL：ALL | | sys_name | String | 系统名称 | | table_name | String | 表名 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表12DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表14DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v1/{project_id}/{instance_id}/audit/sqls { "time" : { "time_range" : "DAY", "start_time" : null, "end_time" : null }, "risk_levels" : null, "client_ip" : null, "client_name" : null, "db_ip" : null, "db_user" : null, "query_type" : null, "rule_name" : null, "sql_statement" : null, "sql_response" : null, "page" : 1, "size" : 50, "time_order" : "DESC" } ``` #### 响应示例 **状态码：200** 成功 ``` { "total" : 2, "count" : 2, "sqls" : [ { "sql" : { "id" : "o1n8BI8BDdIO3rwS4Rea", "sql_statement" : "create table test(name varchar(1000), age int)", "client_ip" : "fe80::f816:3eff:feca:22f5", "client_name" : "", "db_ip" : "fe80::f816:3eff:feca:22f5", "db_user" : "root", "query_type" : "CREATE TABLE", "operated_obj_info" : [ { "column_name" : "", "object_type" : "TABLE", "schema_name" : "test", "sql_type" : "CREATE TABLE", "sys_name" : "", "table_name" : "test" }, { "column_name" : "", "object_type" : "TABLE", "schema_name" : "test", "sql_type" : "CREATE", "sys_name" : "", "table_name" : "test" } ], "rule_name" : "全审计规则", "risk_level" : "", "start_time" : "2024-04-22 08:46:02", "sql_response" : "SUCCESS", "db_instance" : "" } }, { "sql" : { "id" : "pFn8BI8BDdIO3rwS4Rea", "sql_statement" : "create table test", "client_ip" : "fe80::f816:3eff:feca:22f5", "client_name" : "", "db_ip" : "fe80::f816:3eff:feca:22f5", "db_user" : "root", "query_type" : "CREATE", "operated_obj_info" : [ { "column_name" : "", "object_type" : "", "schema_name" : "test", "sql_type" : "CREATE", "sys_name" : "", "table_name" : "" } ], "rule_name" : "全审计规则", "risk_level" : "", "start_time" : "2024-04-22 08:46:02", "sql_response" : "FAILED", "db_instance" : "" } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 请求参数错误 | | 403 | 认证失败 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。