All Products
Document Center

ApsaraDB for MongoDB:DescribeAuditPolicy

Last Updated:Nov 06, 2023

Queries whether the audit log feature is enabled for an ApsaraDB for MongoDB instance.

Operation Description

  • The instance must be in the running state when you call this operation.
  • 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.


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.


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
  • dbinstance

Request parameters


The ID of the instance.


Response parameters


The ID of the request.


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

  • Enable
  • Disabled

Default value: Disabled.



Sample success responses


  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "LogAuditStatus": "Enable"

Error codes

HTTP status codeError codeError message
400InvalidDBInstance.MalformedToo many instance ids or instance id format is invalid.

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