ModifyAuditPolicy - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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.

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.

debugging

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
dds:ModifyAuditPolicy	WRITE	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	dds-bp1785659e3f****
AuditStatus	string	Yes	Specifies whether the audit log feature is enabled. Valid values: enable disabled	enable
StoragePeriod	integer	No	The log retention period. Valid values: 1 to 365 days. Default value: 30 days.	30
AuditLogSwitchSource	string	No	The request source for the audit log feature. Set the value to Console.	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.	Standard

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time	Summary of changes	Operation

No change history