All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeRestoreDBInstanceList

    Document Center

    ApsaraDB for MongoDB:DescribeRestoreDBInstanceList

    Last Updated:Jan 26, 2026

    Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.

    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:DescribeRestoreDBInstanceList

    get

    *Instance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNumber

    integer

    No

    The page number.

    1
    PageSize

    integer

    No

    The number of entries returned per page.

    30
    DBInstanceId

    string

    Yes

    The instance ID.

    dds-bp114f14849d****
    CreationTimeAfter

    string

    Yes

    Find instances created after the specified time, formatted as yyyy-MM-ddTHH:00:00Z (UTC time).

    Note

    • The time must be on the hour.

    • The time cannot be earlier than 7 days before the current time.

    2024-07-24T14:00:00Z

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The number of instances in the query results.

    5
    RequestId

    string

    The request ID.

    1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
    PageSize

    integer

    The number of entries returned per page.

    30
    PageNumber

    integer

    The page number.

    1
    DBInstances

    object

    DBInstance

    array<object>

    DB instances list.

    object

    DB instances list.

    CreationTime

    string

    The time of instance creation, formatted as yyyy-MM-ddTHH:00:00Z (UTC time).

    2022-01-02T07:43:59Z
    LockMode

    string

    The locked state of the instance, value description:

    • Unlock: Normal.

    • ManualLock: Manually triggered lock.

    • LockByExpiration: Automatically locked due to expiration.

    • LockByRestoration: Automatically locked before restoration.

    • LockByDiskQuota: Automatically locked due to disk quota exceeded.

    Unlock
    EngineVersion

    string

    The database engine version of the instance. Valid values:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    DBInstanceDescription

    string

    The description of the instance.

    测试数据库
    DBInstanceType

    string

    The architecture of the instance. Valid values:

    • sharding: sharded cluster instance

    • replicate: replica set or standalone instance

    replicate
    DBInstanceStatus

    string

    The status of the instance. For more information, see Instance states.

    Running
    RegionId

    string

    The region ID of the instance.

    cn-hangzhou
    ZoneId

    string

    The zone ID of the instance.

    cn-hangzhou-g
    DBInstanceId

    string

    The instance ID.

    dds-bp12c5b040dc****
    IsDeleted

    integer

    Specifies whether the instance is deleted. Valid values:

    • 0: not deleted

    • 1: deleted

    0

    Examples

    Success response

    JSON format

    {
  "TotalCount": 5,
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "DBInstanceDescription": "测试数据库",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "IsDeleted": 0
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The specified parameter %s is not valid. The specified parameter %s is not valid.
    400 InvalidDBInstanceId.NotFound Specified instance does not exist. Instance not found. Refresh the page to check whether the instance has been released.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.