Enable & Manage Audit Logs with ModifyAuditPolicy - ApsaraDB for MongoDB

Configures the audit log switch or the storage duration of logs for a MongoDB instance.

Operation description

This API applies to General-purpose local disk instances and Dedicated local disk instances.
This API limits the number of calls to 30 per minute. Exceeding this limit triggers rate limiting. Avoid making frequent calls. For frequent calls, use Logstore. For more information, see Manage Logstore.

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

dds:ModifyAuditPolicy

update

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp1785659e3f****
AuditStatus	string	Yes	The audit log status. Valid values: enable: Enable audit logs. disabled: Disable audit logs.	enable
StoragePeriod	integer	No	For the Standard (official) version, this is the retention period for audit logs. Valid values are 1 to 365 days. The default value is 30 days. For the V2_Standard (DAS Enterprise Edition (NoSQL Compatible) audit log) version, this is the cold storage duration for audit logs. Valid values are 30, 180, 365, 1095, and 1825 days.	30
AuditLogSwitchSource	string	No	The request source for audit logs. Set to Console.	Console
ServiceType	string	No	The version type of audit logs. Trial: free trial version. Standard: Official version. V2_Standard: DAS Enterprise Edition (NoSQL Compatible) audit log. Note The default value for this parameter is Trial. Starting from January 6, 2022, official audit logs will be launched in regions, and requests for the free trial version of audit logs will be terminated. Starting from February 2026, DAS Enterprise Edition (NoSQL Compatible) audit logs will be launched in regions, and requests for the official version of audit logs will be terminated.	Standard
HotStoragePeriod	integer	No	This parameter is valid for the V2_Standard (DAS Enterprise Edition (NoSQL Compatible) audit log) version. It specifies the hot storage duration for audit logs. Valid values are 0 to 7 days.	7

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	DC04D812-F18D-4568-9B88-F260D9590116

Examples

Success response

JSON format

{
  "RequestId": "DC04D812-F18D-4568-9B88-F260D9590116"
}

Error codes

HTTP status code	Error code	Error message	Description
404	EntityNotExistUser	The User does not exist.
404	EntityNotExistService	The Service mongodb.aliyuncs.com does not exist.
404	NoPermissionService	The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409	EntityAlreadyExistsRole	The Role already exists:AliyunServiceRoleForMongoDB.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.