调用DescribeAuditRecords查询Redis实例的审计日志。
本接口的调用频率上限为100次/分钟,本接口对应的控制台操作请参见查询审计日志。
调用本接口时,实例必须满足以下条件:
- Redis实例为社区版或企业版(性能增强型)。
- Redis实例的引擎版本为4.0或以上。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAuditRecords | 系统规定参数,取值:DescribeAuditRecords。 |
InstanceId | String | 是 | r-bp1zxszhcgatnx**** | 需要查询的实例的ID。 |
StartTime | String | 是 | 2019-03-24T12:10:00Z | 查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
EndTime | String | 是 | 2019-03-25T12:10:00Z | 查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
说明 由于审计日志的条目数较多,一般查询的时间范围建议在10分钟以内,最长不超过1天。
|
HostAddress | String | 否 | 127.0.0.1 | 客户端IP,默认为显示所有地址。 |
NodeId | String | 否 | r-bp1zxszhcgatnx****-db-0 | 实例中的节点ID。传入本参数可查询指定节点的监控信息。
说明
|
AccountName | String | 否 | demo | 账号名称,默认为所有账号。 |
DatabaseName | String | 否 | 0 | 数据库名称。 |
QueryKeywords | String | 否 | maxclients | 根据指定的命令查询审计日志,默认查询所有执行过的命令。
说明 只能传入单个关键词。
|
PageSize | Integer | 否 | 30 | 每页显示的最大记录数。 |
PageNumber | Integer | 否 | 1 | 当前显示的页码。 |
RegionId | String | 否 | cn-hangzhou | 地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of SQL | 由审计日志组成的集合。 |
|
SQL | |||
AccountName | String | demo | 账号名称。 |
DatabaseName | String | demo | 数据库名称。 |
ExecuteTime | String | 2019-03-25T03:22:08Z | 执行时间。 |
HostAddress | String | 127.0.0.1 | 客户端地址。 |
IPAddress | String | 192.16.100.*** | IP地址。 |
NodeId | String | r-bp1zxszhcgatnx****-db-0 | 节点ID。
说明 实例为集群或读写分离架构时,本参数才会返回具体的节点ID。
|
SQLText | String | CONFIG GET maxmemory | 命令记录。 |
SQLType | String | non_read_write | 命令类型。 |
TotalExecutionTimes | String | 0 | 执行消耗时间。 |
StartTime | String | 2019-03-24T12:10:00Z | 查询开始时间。 |
EndTime | String | 2019-03-25T12:10:00Z | 查询结束时间。 |
PageNumber | Integer | 1 | 当前显示的页码。 |
PageSize | Integer | 30 | 每页显示的最大记录数。 |
RequestId | String | 9F5EB478-824E-4AC4-8D2B-58F31A02**** | 请求ID。 |
InstanceName | String | r-bp1zxszhcgatnx**** | 实例名称。 |
TotalRecordCount | Integer | 22222 | 总记录数。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeAuditRecords &InstanceId=r-bp1zxszhcgatnx**** &StartTime=2019-03-24T12:10:00Z &EndTime=2019-03-25T12:10:00Z &<公共请求参数>
正常返回示例
XML
格式
<DescribeAuditRecordsResponse> <Items> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:08Z</ExecuteTime> <SQLText>CONFIG GET band-width</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:08Z</ExecuteTime> <SQLText>CONFIG GET maxmemory</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:08Z</ExecuteTime> <SQLText>CONFIG GET maxclients</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:08Z</ExecuteTime> <SQLText>CONFIG GET qps</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:03Z</ExecuteTime> <SQLText>CONFIG GET qps</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:03Z</ExecuteTime> <SQLText>CONFIG GET maxclients</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> <SQL> <TotalExecutionTimes>0</TotalExecutionTimes> <DatabaseName>0</DatabaseName> <HostAddress>127.0.0.1</HostAddress> <ExecuteTime>2019-03-25T03:22:03Z</ExecuteTime> <SQLText>CONFIG GET maxmemory</SQLText> <AccountName>0</AccountName> <SQLType>non_read_write</SQLType> </SQL> </Items> <TotalRecordCount>36559</TotalRecordCount> <PageNumber>1</PageNumber> <PageSize>30</PageSize> <RequestId>9F5EB478-824E-4AC4-8D2B-58F31A02****</RequestId> <EndTime>2019-03-25T12:10:00Z</EndTime> <StartTime>2019-03-24T12:10:00Z</StartTime> <InstanceName>r-bp1zxszhcgatnx****</InstanceName> </DescribeAuditRecordsResponse>
JSON
格式
{ "Items": { "SQL": [ { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:08Z", "SQLText": "CONFIG GET band-width", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:08Z", "SQLText": "CONFIG GET maxmemory", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:08Z", "SQLText": "CONFIG GET maxclients", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:08Z", "SQLText": "CONFIG GET qps", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:03Z", "SQLText": "CONFIG GET qps", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:03Z", "SQLText": "CONFIG GET maxclients", "AccountName": "0", "SQLType": "non_read_write" }, { "TotalExecutionTimes": "0", "DatabaseName": "0", "HostAddress": "127.0.0.1", "ExecuteTime": "2019-03-25T03:22:03Z", "SQLText": "CONFIG GET maxmemory", "AccountName": "0", "SQLType": "non_read_write" } ] }, "TotalRecordCount": 36559, "PageNumber": 1, "PageSize": 30, "RequestId": "9F5EB478-824E-4AC4-8D2B-58F31A02****", "EndTime": "2019-03-25T12:10:00Z", "StartTime": "2019-03-24T12:10:00Z", "InstanceName": "r-bp1zxszhcgatnx****" }
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | 结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z |
访问错误中心查看更多错误码。