首页 云原生内存数据库Tair API参考 API目录 日志管理 DescribeAuditRecords - 查询Redis实例的审计日志

DescribeAuditRecords - 查询Redis实例的审计日志

查询Redis实例的审计日志。

接口说明

本接口的调用频率上限为100次/分钟,本接口对应的控制台操作请参见查询审计日志

调用本接口时,实例必须满足以下条件:

  • Redis实例为社区版或Tair内存型。
  • Redis实例的引擎版本为4.0或以上。
  • Redis实例已开启审计日志开关,详情请参见ModifyAuditLogConfig

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeAuditRecordsREAD
  • Redis
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

需要查询的实例的ID。

r-bp1zxszhcgatnx****
NodeIdstring

实例中的节点ID。传入本参数可查询指定节点的监控信息。

说明
  • 当Redis实例的架构为读写分离或集群架构时,本参数才可用。
  • 您可以调用DescribeLogicInstanceTopology接口查询节点ID。
  • r-bp1zxszhcgatnx****-db-0
    AccountNamestring

    账号名称,默认(不填任何值)为查询所有账号。

    demo
    DatabaseNamestring

    Redis中的Database,默认(不填任何值)为查询所有DB,取值为0 ~ 255,示例0表示DB 0。

    0
    QueryKeywordsstring

    根据指定的命令查询审计日志,默认查询所有执行过的命令。

    说明只能传入单个关键词。
    maxclients
    HostAddressstring

    客户端IP,默认(不填任何值)为查询所有地址。

    127.0.0.1
    PageSizeinteger

    每页显示的最大记录数。

    30
    PageNumberinteger

    当前显示的页码。

    1
    StartTimestring

    查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

    2019-03-24T12:10:00Z
    EndTimestring

    查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

    说明由于审计日志的条目数较多,一般查询的时间范围建议在10分钟以内,最长不超过1天。
    2019-03-25T12:10:00Z

    返回参数

    名称类型描述示例值
    object
    EndTimestring

    查询结束时间。

    2019-03-25T12:10:00Z
    StartTimestring

    查询开始时间。

    2019-03-24T12:10:00Z
    RequestIdstring

    请求ID。

    9F5EB478-824E-4AC4-8D2B-58F31A02****
    InstanceNamestring

    实例名称。

    r-bp1zxszhcgatnx****
    TotalRecordCountinteger

    总记录数。

    22222
    PageNumberinteger

    当前显示的页码。

    1
    PageSizeinteger

    每页显示的最大记录数。

    30
    Itemsarray

    由审计日志组成的集合。

    object
    HostAddressstring

    客户端地址。

    127.0.0.1
    SQLTextstring

    命令记录。

    CONFIG GET maxmemory
    DatabaseNamestring

    数据库名称。

    demo
    SQLTypestring

    命令类型。

    non_read_write
    ExecuteTimestring

    执行时间。

    2019-03-25T03:22:08Z
    TotalExecutionTimesstring

    执行消耗时间。

    0
    NodeIdstring

    节点ID。

    说明实例为集群或读写分离架构时,本参数才会返回具体的节点ID。
    r-bp1zxszhcgatnx****-db-0
    AccountNamestring

    账号名称。

    demo
    IPAddressstring

    IP地址。

    192.16.100.***

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2019-03-25T12:10:00Z",
      "StartTime": "2019-03-24T12:10:00Z",
      "RequestId": "9F5EB478-824E-4AC4-8D2B-58F31A02****",
      "InstanceName": "r-bp1zxszhcgatnx****",
      "TotalRecordCount": 22222,
      "PageNumber": 1,
      "PageSize": 30,
      "Items": {
        "SQL": [
          {
            "HostAddress": "127.0.0.1",
            "SQLText": "CONFIG GET maxmemory",
            "DatabaseName": "demo",
            "SQLType": "non_read_write",
            "ExecuteTime": "2019-03-25T03:22:08Z",
            "TotalExecutionTimes": "0",
            "NodeId": "r-bp1zxszhcgatnx****-db-0",
            "AccountName": "demo",
            "IPAddress": "192.16.100.***"
          }
        ]
      }
    }

    错误码

    Http code错误码错误信息描述
    400IncorrectDBInstance.NotSupportedThis instance do not support log audit.-
    400InvalidEndTime.Invalidpecified end time is before this service active time.-
    400InvalidStartTime.MalformedThe Specified parameter StartTime is not valid.-
    400InvalidEndTime.MalformedThe Specified parameter EndTime is not valid.结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z
    400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.-
    400InvalidPageNumbers.MalformedSpecified page number is not valid.-
    400InvalidQueryTime.FormatSpecified query time is not valid.-

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

    阿里云首页 云原生内存数据库Tair 相关技术圈