Restoring Data to the Original or Existing Instance
Function
This API is used to restore data to the original DB instance or an existing DB instance. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/recovery
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
source |
Yes |
Object |
Definition Instance from which the backup was created. For details, see Table 3. Constraints N/A |
target |
Yes |
Object |
Definition The instance to which the backup is restored. For details, see Table 4. Constraints N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A |
type |
Yes |
String |
Definition Restoration mode. Constraints N/A
Default Value backup |
backup_id |
No |
String |
Definition Backup ID used for restoration. It indicates the ID of the full backup corresponding to schema_type. This parameter must be specified when backups are used for restoration. Constraints N/A Range N/A Default Value N/A |
restore_time |
No |
String |
Definition Timestamp to which data is restored to using point-in-time recovery. You can query the available time range by calling the Querying the Restoration Time Range API. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Definition ID of the DB instance which the backup will be restored to.
Constraints N/A Range N/A Default Value N/A |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition Job ID. Range N/A |
Example Request
Restoring data to the original or existing instance
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source" : { "instance_id" : "5362449138da4e408dbae5152ca26640in14", "type" : "backup", "backup_id" : "cc94568cb5a54e4a8ab5dff95e64a5e0br14" }, "target" : { "instance_id" : "5362449138da4e408dbae5152ca26640in14" } }
Example Response
Data restored to the original or existing instance.
{ "job_id" : "a03b1b8a-b756-467c-8a49-38720c3d23ec" }
Status Codes
- Normal
- Abnormal
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot