DescribeSqlAuditStat - 统计 SQL 执行情况 - 云数据库 OceanBase （文档停止维护）

按照客户端IP、用户、SQLID的维度统计SQL数据执行情况

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oceanbase:DescribeSqlAuditStat

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	集群实例 ID	ob317v4uif****
TenantId	string	否	租户 ID	t33h8y08k****
StartTime	string	否	开始时间 yyyy-MM-dd'T'HH:mm:ss'Z'	2025-01-14T02:34:49Z
EndTime	string	否	结束时间 yyyy-MM-dd'T'HH:mm:ss'Z' （时间跨度不能超过 6 小时）	2025-01-14T03:34:49Z
PageSize	integer	否	分页大小	1
PageNumber	integer	否	分页页码	1
OperatorType	string	否	操作类型	INSERT

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Data	array<object>	请求返回的信息
	object	请求返回的信息
InstanceId	string	集群实例 ID	ob317v4uif****
TenantId	string	租户 ID	t33h8y08k****
UserClientIp	string	客户端 IP	xx.xx.xx.xx
UserName	string	用户名	test_mysql
DatabaseName	string	数据库名	test_database_1
SqlId	string	Sql ID	8D6E84**0B8FB1823D199E2CA1**
TotalSucceed	integer	总成功条数	1
TotalFailed	integer	总失败条数	0
TotalAffectRows	integer	总影响行数	1
TotalScanRows	integer	总扫描行数	10
TotalReturnRows	integer	总返回行数	1
AffectRows	number	平均影响行数（0 的数据不计算在内）四舍五入	1
ScanRows	number	平均扫描行数 0 的数据不计算在内）四舍五入	1
ReturnRows	number	平均返回行数（0 的数据不计算在内）四舍五入	1
ExecuteTime	number	平均执行耗时单位 ms	142
SqlStatement	string	SQL 模板	UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?
OperatorType	string	操作类型	UPDATE
TotalCount	integer	总数	9

示例

正常返回示例

JSON格式

{
  "RequestId": "\t\nEE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\n",
  "Data": [
    {
      "InstanceId": "ob317v4uif****",
      "TenantId": "t33h8y08k****",
      "UserClientIp": "xx.xx.xx.xx\n",
      "UserName": "test_mysql ",
      "DatabaseName": "test_database_1",
      "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
      "TotalSucceed": 1,
      "TotalFailed": 0,
      "TotalAffectRows": 1,
      "TotalScanRows": 10,
      "TotalReturnRows": 1,
      "AffectRows": 1,
      "ScanRows": 1,
      "ReturnRows": 1,
      "ExecuteTime": 142,
      "SqlStatement": "UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?",
      "OperatorType": "UPDATE"
    }
  ],
  "TotalCount": 9
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。