Obtaining the List of Database Collections That Can Be Restored

Description

This API is used to obtain the list of databases collections that can be restored.

Constraints

This API applies only to replica sets.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:backup:getRestoreCollections	list	-	-	dds:instance:list	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/restore-collection
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&restore_time=1607689584000&limit=10&offset=0

**Table 1** Parameter description
Name	Type	Mandatory	Description
X-Auth-Token	String	Yes	User token obtained from IAM. For details, see Authentication.
X-Language	String	No	Language
project_id	String	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	String	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.
db_name	String	Yes	Specifies the database name.
restore_time	String	Yes	Specifies the restoration time point. The value is a UNIX timestamp, in milliseconds. The time zone is UTC.
offset	Integer	No	Specifies the index position. The value is an integer greater than or equal to 0. If this parameter is not transferred, the value is 0 by default.
limit	Integer	No	Specifies the upper limit of the number of queried records. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 records are queried by default.

Request

None

Response

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
collections	Array of objects	Yes	Indicates the list of collections. Each element in the list indicates a collection.
total_count	Integer	Yes	Indicates the total number of collections.

**Table 3** Parameter description
Name	Type	Mandatory	Description
name	String	Yes	Indicates the collection name.

Example Response

{
  "collections": [
    "dds-test"
  ],
  "total_count": 1
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.