All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyAuditPolicy

Last Updated:Jun 25, 2024

Enables or disables the audit log feature or configures the log storage duration 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:ModifyAuditPolicyWrite
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

dds-bp1785659e3f****
AuditStatusstringYes

Specifies whether to enable the audit log feature. Valid values:

  • enable
  • disabled
enable
StoragePeriodintegerNo

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

30
AuditLogSwitchSourcestringNo

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

Console
ServiceTypestringNo

The type of the audit log feature. Valid values:

  • Trail: free trial edition.
  • Standard: official edition.
Note The default value is Trail. Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and the free trial edition of the feature can no longer be applied for. We recommend that you set this parameter to Standard.
Standard

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

DC04D812-F18D-4568-9B88-F260D9590116

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
404EntityNotExistUserThe User does not exist.
404EntityNotExistServiceThe Service mongodb.aliyuncs.com does not exist.
404NoPermissionServiceThe Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409EntityAlreadyExistsRoleThe Role already exists:AliyunServiceRoleForMongoDB.

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

Change history

Change timeSummary of changesOperation
No change history