Restoring Databases and Tables to a Point in Time

Description

Restrictions

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore/collections

Requests

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  restore_collections	Array of objects	Yes	The database information. For details, see Table 3.

  Table 3 restore_collections data structure description

  Name	Type	Mandatory	Description
  database	String	Yes	Database name.
  collections	Array of objects	No	The collection information. For details, see Table 4.
  restore_database_time	String	No	The database restoration time point. This parameter is mandatory for database-level restoration, The value is a UNIX timestamp, in milliseconds. The time zone is UTC.

  Table 4 collections data structure description

  Name	Type	Mandatory	Description
  old_name	String	Yes	The table name before the restoration.
  new_name	String	No	The table name after the restoration.
  restore_collection_time	String	Yes	The collection restoration time point. The value is a UNIX timestamp, in milliseconds. The time zone is UTC.

• Request example
  • Database-level restoration

    {
      "restore_collections": [
        {
          "database": "test",
          "restore_database_time": 1607762955000
        }
      ]
    }
    
    

  • Collection-level restoration

    {
      "restore_collections": [
        {
          "database": "test",
          "collections": [
            {
              "old_name": "test",
              "restore_collection_time": 1607762955000
            }
          ]
        }
      ]
    }
    
    

Responses

• Parameter description

  Table 5 Parameter description

  Name	Type	Mandatory	Description
  job_id	String	Yes	ID of the asynchronous task for the restore operation.

• Response example

  {
      "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec"
  }
  
  

Status Code

Error Code