DescribeRestoreDBInstanceList - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

Debugging

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
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. Enumeration Value: 30 50 100 5	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 parameters

Parameter	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	array<object>	DB instances list.
DBInstance	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.	test-database
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****
SecondaryZoneId	string	The secondary availability zone 1 for the instance when implementing multi-AZ deployment.	cn-hangzhou-i
HiddenZoneId	string	The secondary availability zone 2 for the instance when implementing multi-AZ deployment.	cn-hangzhou-h
IsDeleted	integer	Specifies whether the instance is deleted. Valid values: 0: not deleted 1: deleted	0

Examples

Sample success responses

JSONformat

{
  "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": "test-database",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "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.

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