DescribeAuditLogs - 查询审计告警日志

更新时间:
复制 MD 格式

本接口一般用于数据审计告警日志列表查询,便于告警搜索和告警处理。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:DescribeAuditLogs

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Lang

string

否

请求和接收消息的语言类型,默认为 zh_cn。取值:

  • zh_cn:中文。

  • en_us:英文。

zh-CN

UserName

string

否

用户名

admin

ClientIp

string

否

请求客户端 IP。

11.26.118.7

ClientUa

string

否

客户端类型。

mysql

InstanceName

string

否

资产实例名称

rm-t4ni1cezz5y3xxxx

DatabaseName

string

否

数据库的名称。

TestDB

StartTime

integer

否

告警日志起始时间,单位为毫秒。

1608888296000

EndTime

integer

否

告警日志结束时间,以毫秒为单位的 unix 时间戳。

15682887991222

ProductCode

string

否

数据资产所属的产品名称。取值:RDS、PolarDB、PolarDB-X 2.0等。

RDS

ProductId

integer

否

数据对象所属的产品名称对应的 ID。取值:

  • 3:ADB-MYSQL

  • 5:RDS

  • 7:PolarDB-X

  • 8:PolarDB

  • 9:ADB-PG

  • 11:MongoDB

  • 25:Redis

5

SqlText

string

否

SQL 语句内容。

SELECT * FROM test where name = 'das'

ExecuteTimeRange

string

否

执行时间的范围。

in[1000 2000]

EffectRowRange

string

否

影响行数范围。

in[1 33]

RuleName

string

否

审计规则名称。

test_rule

OperateType

string

否

操作类型。

Insert

OssObjectKey

string

否

OSS 存储对象的 key 值。

N.A

AsyncRequestId

string

否

请求 id。

2c548e83-1473-4fda-b3dc-5a189074ead5

PageSize

integer

否

每页最大记录数,默认值为 10。

30

CurrentPage

integer

否

当前页数。

3

RuleCategory

string

否

规则类型。

10

LoadWhiteList

boolean

否

是否加载白名单状态。

false

IpType

string

否

网络类型。枚举类型,取值:

  • default(默认值):非阿里云服务

  • aliyun: 阿里云服务

aliyun

LogSource

string

否

数据来源

SLOW_SQL

RuleAggQuery

boolean

否

是否聚合查询

true

RuleId

string

否

规则 ID

867028

LogQueryOpJson

string

否

返回参数

名称

类型

描述

示例值

object

AsyncRequestId

string

请求 id。

3926fba5-1774-44f4-af2d-ac7b33e86c3b

CurrentPage

integer

当前页数。

1

Items

array<object>

SQL 日志记录中的客户端 IP SQL 日志记录中客户端的 IP 地址

object

物理异步读。

ClientIp

string

查询中的客户端 IP 地址

100.104.16.251

ClientPort

string

查询中客户端端口号

53815

ClientUa

string

客户端类型。

mysql

ColumnName

string

列名。

ds

CreationTime

integer

告警时间,单位为毫秒。

1536751124000

DatabaseName

string

数据库名称。

chngc_b2b_migration_sh

EffectRow

integer

影响行数。

10

ExecuteStatus

integer

执行状态:0:未成功 1:执行成功

1

ExecuteTime

integer

执行时长,单位为毫秒。

1751870592000

Id

integer

主键 ID。

1

InWhiteList

boolean

告警是否在加白列表。

True

InstanceAuditStatus

string

实例审计状态

2

InstanceDescription

string

数据资产实例的描述信息。

instance dscription

InstanceName

string

实例别名。

test-instance-003

IpType

string

网络类型。枚举类型,取值:

default(默认值):非阿里云服务

aliyun: 阿里云服务

aliyun

LogSource

string

数据来源

SLOW_SQL

LogTime

integer

日志执行时间。

1751870592000

Message

string

原始日志内容。

success

OperateType

string

操作类型。

Drop

OssObjectKey

string

OSS 存储对象的 key 值。

N.A

PackageName

string

MaxCompute 包名称。

test01

ProductCode

string

数据资产所属的产品名称。取值:RDS、PolarDB、PolarDB-X 2.0 等。

RDS

ProductId

integer

数据对象所属的产品名称对应的 ID。取值:

  • 3:ADB-MYSQL

  • 5:RDS

  • 7:PolarDB-X

  • 8:PolarDB

  • 9:ADB-PG

  • 11:MongoDB

  • 25:Redis

5

RuleCategory

string

规则类型。

10

RuleId

string

审计规则 id。

9953411

RuleName

string

审计规则名称。

name

SqlText

string

SQL 语句。

select * from test03

TableName

string

查询中使用的表名

it_table

UserId

string

用户 UID。

19********94

UserName

string

用户名

admin

WarnLevel

string

危险等级。

  • 1:低危。

  • 2:中危。

  • 3:高危。

1

WarnLevelName

string

危险等级名称。

  • 低危。

  • 中危。

  • 高危。

1

PageSize

integer

分页查询,每页大小。

10

RequestId

string

请求 ID。

A7021857-AFD9-5AD6-979D-AA7DFC5AFADF

TotalCount

integer

总的记录数(仅 Redis 引擎有效)

12

示例

正常返回示例

JSON格式

{
  "AsyncRequestId": "3926fba5-1774-44f4-af2d-ac7b33e86c3b",
  "CurrentPage": 1,
  "Items": [
    {
      "ClientIp": "100.104.16.251",
      "ClientPort": "53815",
      "ClientUa": "mysql",
      "ColumnName": "ds",
      "CreationTime": 1536751124000,
      "DatabaseName": "chngc_b2b_migration_sh",
      "EffectRow": 10,
      "ExecuteStatus": 1,
      "ExecuteTime": 1751870592000,
      "Id": 1,
      "InWhiteList": true,
      "InstanceAuditStatus": "2",
      "InstanceDescription": "instance dscription",
      "InstanceName": "test-instance-003",
      "IpType": "aliyun",
      "LogSource": "SLOW_SQL",
      "LogTime": 1751870592000,
      "Message": "success",
      "OperateType": "Drop",
      "OssObjectKey": "N.A",
      "PackageName": "test01",
      "ProductCode": "RDS",
      "ProductId": 5,
      "RuleCategory": "10",
      "RuleId": "9953411",
      "RuleName": "name",
      "SqlText": "select * from test03",
      "TableName": "it_table",
      "UserId": "19********94",
      "UserName": "admin",
      "WarnLevel": "1",
      "WarnLevelName": "1"
    }
  ],
  "PageSize": 10,
  "RequestId": "A7021857-AFD9-5AD6-979D-AA7DFC5AFADF",
  "TotalCount": 12
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
403 NoPermission You are not authorized to do this action. 没有权限执行该操作

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

变更历史

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