文档

DescribeAuditLogConfig - 查询审计日志配置

更新时间:

查询Redis实例审计日志是否开启、日志保存时间等配置信息。

接口说明

说明 您可以调用 ModifyAuditLogConfig 接口为实例开启或关闭审计日志。更多信息,请参见审计日志

调用本接口时,Redis 实例必须已开启审计日志开关,详情请参见 ModifyAuditLogConfig

调试

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

授权信息

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

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

请求参数

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

实例所属地域的 ID,您可以调用 DescribeInstanceAttribute 接口查询。

cn-hanghzou
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
Retentionstring

审计日志的保留时长,单位为天。

5
RequestIdstring

请求 ID。

2BE6E619-A657-42E3-AD2D-18F8428A****
DbAuditstring

是否开启审计日志,返回值:

  • true:开启。
  • false:关闭。
说明 您可以调用 ModifyAuditLogConfig 接口为实例开启或关闭审计日志。
true

示例

正常返回示例

JSON格式

{
  "Retention": "5",
  "RequestId": "2BE6E619-A657-42E3-AD2D-18F8428A****",
  "DbAudit": "true"
}

错误码

HTTP status code错误码错误信息描述
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.实例不存在我们的记录中,调用DescribeInstances接口查 看当前用户下面的实例信息

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

变更历史

变更时间变更内容概要操作
2023-08-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:404
  • 本页导读 (1)
文档反馈