All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeMongoDBLogConfig

    Document Center

    ApsaraDB for MongoDB:DescribeMongoDBLogConfig

    Last Updated:Feb 09, 2026

    You can view the configuration of MongoDB Log Service.

    Operation description

    This API applies to General-purpose and Dedicated instances that use local disks.

    You can enable the audit log feature for ApsaraDB for MongoDB as needed. For more information, see Enable audit logs.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:DescribeMongoDBLogConfig

    get

    *dbinstance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    The instance ID. Call DescribeDBInstances to query the instance ID.

    dds-bp12c5b040dc****

    Response elements

    Element

    Type

    Description

    Example

    object

    The audit log configuration.

    UserProjectName

    string

    The name of the Simple Log Service project for the audit logs.

    nosql-176498472570****-cn-hangzhou
    RequestId

    string

    The request ID.

    664ECE26-658A-47C5-88F6-870B0132E8D2
    IsUserProjectLogstoreExist

    integer

    Indicates whether a Simple Log Service project for audit logs exists in the current region. Valid values:

    • 1: The project exists.

    • 0 or null: The project does not exist.

    1
    IsEtlMetaExist

    integer

    Indicates whether a rule is created to ship audit logs to Logtail. For more information about Logtail, see What is Logtail?. Valid values:

    • 1: A rule is created.

    • 0 or null: No rule is created.

    1
    ServiceType

    string

    The version of the audit log feature.

    • Trial: Free trial version.

    • Standard: Official version.

    • V2_Standard: DAS Enterprise Edition (NoSQL-compatible) version.

    Standard
    EnableAudit

    boolean

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

    • true: Enabled.

    • false: Disabled.

    true
    TtlForTrail

    integer

    The retention period of audit logs for the free trial version. Unit: days.

    1
    UsedStorageForTrail

    integer

    The storage capacity that is used by audit logs for the free trial version. Unit: bytes.

    12548178759
    PreserveStorageForTrail

    integer

    The maximum storage capacity for the free trial version of audit logs. Unit: bytes. The maximum value is 107374182400 bytes.

    107374182400
    TtlForStandard

    integer

    The retention period of audit logs for the official version. The value ranges from 1 to 365. Unit: days.

    30
    UsedStorageForStandard

    integer

    The storage capacity that is used by audit logs for the official version. Unit: bytes.

    20163
    PreserveStorageForStandard

    integer

    The maximum storage capacity for the official version of audit logs. A value of -1 indicates that no upper limit is set.

    -1
    HotTtlForV2Standard

    integer

    The retention period of hot storage for the V2_Standard (DAS Enterprise Edition (NoSQL-compatible)) version of audit logs. Unit: days.

    7
    TtlForV2Standard

    integer

    The retention period of cold storage for the V2_Standard (DAS Enterprise Edition (NoSQL-compatible)) version of audit logs. Unit: days.

    30

    Examples

    Success response

    JSON format

    {
  "UserProjectName": "nosql-176498472570****-cn-hangzhou",
  "RequestId": "664ECE26-658A-47C5-88F6-870B0132E8D2",
  "IsUserProjectLogstoreExist": 1,
  "IsEtlMetaExist": 1,
  "ServiceType": "Standard",
  "EnableAudit": true,
  "TtlForTrail": 1,
  "UsedStorageForTrail": 12548178759,
  "PreserveStorageForTrail": 107374182400,
  "TtlForStandard": 30,
  "UsedStorageForStandard": 20163,
  "PreserveStorageForStandard": -1,
  "HotTtlForV2Standard": 7,
  "TtlForV2Standard": 30
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.