All Products
Document Center

ApsaraDB for MongoDB:DescribeAuditPolicy

Last Updated:Jan 17, 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.

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:DescribeAuditPolicy READ
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.


Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.

LogAuditStatus string

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

  • Enable
  • Disabled

Default value: Disabled.



Normal return example


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

Error codes

Http code Error code Error message
400 InvalidDBInstance.Malformed Too many instance ids or instance id format is invalid.

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