ModifyAuditLogConfig -

Enables the audit log feature or modifies the audit log settings for an ApsaraDB for Redis instance.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of the 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 major version and minor version.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:ModifyAuditLogConfig	update	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#InstanceId}	kvstore:DbAudit	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.	r-bp1zxszhcgatnx****
Retention	integer	No	The retention period of audit logs. Valid values: 1 to 365. Unit: days. Note This parameter is required only if the DbAudit parameter is set to true. The value of this parameter takes effect for all ApsaraDB for Redis instances in the current region.	10
DbAudit	boolean	No	Specifies whether to enable the audit log feature. Default value: true. Valid values: true: enables the audit log feature. false: disables the audit log feature. Note If the instance uses the cluster architecture or read/write splitting architecture, the audit log feature is enabled or disabled for both the data nodes and proxy nodes. You cannot separately enable the audit log feature for the data nodes or proxy nodes.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRetention	The Retention is invalid.	-
400	ResourceConfigError	The request processing has failed due to resource config error.	-
403	TaskHasExist	The task already exists.	The task already exists.

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