All Products
Search
Document Center

Tair:DescribeAuditLogConfig

Last Updated:Feb 20, 2024

Queries the audit log configurations of an ApsaraDB for Redis instance. The configurations include whether the audit log feature is enabled and the retention period of audit logs.

Operation description

Note You can call the ModifyAuditLogConfig operation to enable or disable the audit log feature for an ApsaraDB for Redis instance. For more information, see Enable the new audit log feature.

Before you call this operation, make sure that the ApsaraDB for Redis instance meets the following requirements:

  • The instance is an ApsaraDB for Redis Community Edition instance or ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance.
  • The engine version of the instance is Redis 4.0 or later, and the latest minor version is used. You can call the DescribeEngineVersion operation to check whether the instance uses the latest minor version.
  • The audit log feature is enabled for the instance. For more information, see ModifyAuditLogConfig .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeAuditLogConfigRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeInstanceAttribute operation to query the region ID of the instance.

cn-hanghzou
InstanceIdstringYes

The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
Retentionstring

The retention period of audit logs. Unit: days.

5
RequestIdstring

The ID of the request.

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

Indicates whether the audit log feature is enabled. Valid values:

  • true: enabled
  • false: disabled
Note You can call the ModifyAuditLogConfig operation to enable or disable the audit log feature for an ApsaraDB for Redis instance.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.The instance does not exist in the records. Call the DescribeInstances operation to query the instances that belong to the account.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 404