All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeAuditLogFilter

Last Updated:Apr 01, 2024

Queries the types of entries in the audit log collected 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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

dds-bp12c5b040dc****
RoleTypestringNo

The role of the node in the instance. Valid values:

  • mongos: mongos node.
  • db : shard node.
  • logic : logical instance.
logic

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6
Filterstring

The type of the audit log entries. Valid values:

  • admin: O&M and management operations
  • slow: slow query logs
  • query: query operations
  • insert: insert operations
  • update: update operations
  • delete: delete operations
  • command: protocol commands such as the aggregate method
admin,slow,insert,query,update,delete,command
RoleTypestring

The role of the node.

logic

Examples

Sample success responses

JSONformat

{
  "RequestId": "7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6",
  "Filter": "admin,slow,insert,query,update,delete,command",
  "RoleType": "logic"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history