查询Redis实例的审计日志。
接口说明
调用本接口时,Redis 实例必须已开启审计日志开关,详情请参见 ModifyAuditLogConfig 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:DescribeAuditRecords | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 需要查询的实例的 ID。 | r-bp1zxszhcgatnx**** |
NodeId | string | 否 | 实例中的节点 ID。传入本参数可查询指定节点的监控信息。 说明
| r-bp1zxszhcgatnx****-db-0 |
AccountName | string | 否 | 账号名称,默认(不填任何值)为查询所有账号。 | demo |
DatabaseName | string | 否 | Redis 中的 Database,默认(不填任何值)为查询所有 DB,取值为 0 ~ 255,示例 0 表示 DB 0。 | 0 |
QueryKeywords | string | 否 | 根据指定的命令查询审计日志,默认查询所有执行过的命令。 说明
只能传入单个关键词。
| maxclients |
HostAddress | string | 否 | 客户端 IP,默认(不填任何值)为查询所有地址。 | 127.0.0.1 |
PageSize | integer | 否 | 每页显示的最大记录数。 | 30 |
PageNumber | integer | 否 | 当前显示的页码。 | 1 |
StartTime | string | 是 | 查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2019-03-24T12:10:00Z |
EndTime | string | 是 | 查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
由于审计日志的条目数较多,一般查询的时间范围建议在 10 分钟以内,最长不超过 1 天。
| 2019-03-25T12:10:00Z |
返回参数
示例
正常返回示例
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 status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectDBInstance.NotSupported | This instance do not support log audit. | - |
400 | InvalidEndTime.Invalid | pecified end time is before this service active time. | - |
400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | - |
400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | 结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z |
400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | - |
400 | InvalidPageNumbers.Malformed | Specified page number is not valid. | - |
400 | InvalidQueryTime.Format | Specified query time is not valid. | - |
访问错误中心查看更多错误码。