All Products
Document Center

ApsaraDB for MongoDB:ModifyAuditPolicy

Last Updated:Jan 17, 2023

Enables or disables the audit log feature or sets the log retention period for an ApsaraDB for MongoDB instance.

Operation Description

  • This operation is applicable only to general-purpose local-disk and dedicated local-disk instances.
  • You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see Manage a Logstore.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:ModifyAuditPolicy WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

AuditStatus string Yes

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

  • enable
  • disabled
StoragePeriod integer No

The log retention period. Valid values: 1 to 365 days. Default value: 30 days.

AuditLogSwitchSource string No

The request source for the audit log feature. Set the value to Console.

ServiceType string No

The type of the audit log feature. Valid values:

  • Trail: the free trial edition
  • Standard: the official edition
Note Default value: Trial. Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. We recommend that you set this parameter to Standard.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


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

Error codes

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

For a list of error codes, visit the API error center.