Call ModifyAuditLogConfig to enable or modify audit log settings - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Make sure that you understand the billing and pricing of the audit log feature.

The Tair (Redis OSS-compatible) instance must meet the following requirements:

The instance is a Tair (Redis OSS-compatible) Community Edition instance or 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:ModifyAuditLogConfig

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#InstanceId}

kvstore:DbAudit

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call the DescribeInstances operation to query the instance ID.	r-bp1zxszhcgatnx****
Retention	integer	No	The retention period of audit logs. Valid values: 1 to 365. Unit: days. Note This parameter is required only when the DbAudit parameter is set to true. The value of this parameter takes effect for all instances in the current region.	10
DbAudit	boolean	No	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 For instances that use the cluster architecture or read/write splitting architecture, the audit log feature is enabled or disabled for both data nodes and proxy nodes. You cannot separately enable the audit log feature for data nodes or proxy nodes.	true

Response elements

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

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.