Restoring Metadata (a V3 API)

Function

This API is used to restore metadata.

URI

POST /v3/{project_id}/instances/{instance_id}/backups/metadata-recovery

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DDM instance ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
source	Yes	RestoreMetaDataSource object	Source instance for metadata restoration.
target	Yes	RestoreMetaDataTarget object	Target instance for metadata restoration.

**Table 4** RestoreMetaDataSource
Parameter	Mandatory	Type	Description
restore_time	No	Number	Restoration timestamp, accurate to milliseconds. (Either backup_id or restore_time needs to be specified.)
backup_id	No	String	Backup ID. (Either restore_time or backup_id needs to be specified.)

**Table 5** RestoreMetaDataTarget
Parameter	Mandatory	Type	Description
data_nodes	Yes	Array of strings	Target data nodes. They can be obtained from Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API). The data nodes are in the same VPC and subnet as the DDM instance and can communicate with the DDM instance. Data nodes where PITR has been completed.
instance_id	Yes	String	Target instance ID. It can be obtained from Querying Instances That Can Be Used for Restoration (a V3 API).

Response Parameters

Status code: 202

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Request

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/backups/metadata-recovery 

{ 
  "source": { 
    "backup_id": "defa45b24d314e878fde930a61732e9dbr09" 
  }, 
  "target": { 
    "instance_id": "2f0324a93859487eb5566d75951fcd2din09", 
    "data_nodes": [ 
      "f4e2949e9b9b4d60b42c89ed39bfe34cin01" 
    ] 
  } 
}

Example Response

Status code: 202

{
  "job_id": "09902ee7866649b8908ec209bfee2747"
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes	Description
202	OK
400	Bad request
500	Server error

Error Codes

For details, see Error Codes.

Parent topic: Backup Management

Previous topic: Querying Instances That Can Be Used for Restoration (a V3 API)

Next topic: Restoring Data to a New Instance (a V3 API)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot