Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Backup and Restoration/ Obtaining the List of Database Collections That Can Be Restored
Updated on 2022-12-12 GMT+08:00
View PDF

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.

Restrictions

This API applies only to replica sets.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&restore_time={restore_time}&offset={offset}&limit={limit}

  • 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

X-Language

String

No

Language

project_id

String

Yes

Specifies the 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.

Requests

None

Responses

  • 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.
  • Response example 
    {
  "collections": [
    "dds-test"
  ],
  "total_count": 1
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: Backup and Restoration