Enable & Manage Audit Logs with ModifyAuditPolicy - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Operation description

You can call this operation up to 30 times per minute. The system throttles calls that exceed this limit. Avoid calling this operation frequently. If you need to make 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 status of the audit log. Valid values: enable: Enables the audit log feature. disabled: Disables the audit log feature.	enable
StoragePeriod	integer	No	For the Standard edition, this parameter specifies the retention period for the audit log. Valid values: 1 to 365. The default value is 30. Unit: days. For the V2_Standard (DAS Enterprise Edition (NoSQL Compatible) audit log) edition, this parameter specifies the cold storage duration for the audit log. Valid values: 30, 180, 365, 1095, and 1825. Unit: days.	30
AuditLogSwitchSource	string	No	The source of the request. Set this parameter to Console.	Console
ServiceType	string	No	The edition of the audit log. Valid values: Trial: Trial Edition. Standard: Standard Edition. V2_Standard: DAS Enterprise Edition (NoSQL Compatible) audit log. Note The default value of this parameter is Trial. Starting from January 6, 2022, the Standard edition is being rolled out across regions, and new applications for the Trial edition are no longer accepted. Starting from February 2026, the DAS Enterprise Edition (NoSQL Compatible) audit log will be rolled out across regions, and new applications for the Standard edition will no longer be accepted.	Standard
HotStoragePeriod	integer	No	This parameter is effective only for the V2_Standard (DAS Enterprise Edition (NoSQL Compatible) audit log) edition. It specifies the hot storage duration for the audit log. Valid values: 0 to 7. Unit: days.	7

Response elements

Element	Type	Description	Example
	object	The response object.
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
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.