Querying DCS Instance Restoration Records

Function

This API is used to query the restoration records of a specific DCS instance.

URI

GET /v2/{project_id}/instances/{instance_id}/restores

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
begin_time	No	String	Definition: Query start time. Constraints: Format: yyyyMMddHHmmss, for example, 20170718235959. Range: N/A Default Value: N/A
end_time	No	String	Definition: Query end time. Constraints: Format: yyyyMMddHHmmss, for example, 20170718235959. Range: N/A Default Value: N/A
offset	No	Integer	Definition: Offset, which indicates that the generated list is displayed from this offset. For example, if the offset is 3, the generated list is displayed from the fourth record. Constraints: N/A Range: ≥ 0 Default Value: 0
limit	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A Range: 1–1000 Default Value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
restore_record_response	Array of InstanceRestoreInfo objects	Definition: Array of the restoration records.
total_num	Integer	Definition: Total restoration records. Range: N/A

**Table 4** InstanceRestoreInfo
Parameter	Type	Description
backup_id	String	Definition: Backup record ID. Range: N/A
restore_id	String	Definition: ID of the restoration record. Range: N/A
backup_name	String	Definition: Backup record name. Range: N/A
updated_at	String	Definition: Time when the restoration completed. Range: N/A
restore_remark	String	Definition: Description of the restoration. Range: N/A
created_at	String	Definition: Time when the restoration task was created. Range: N/A
progress	String	Definition: Restoration progress. Range: 0–100
error_code	String	Definition: Error code displayed for a restoration failure. Range: "dcs.08.0001": Failed to start the backup and restoration tool. "dcs.08.0002": Execution timed out. "dcs.08.0003": Failed to delete the bucket. "dcs.08.0004": Failed to obtain the AK/SK. "dcs.08.0005": Failed to create a bucket. "dcs.08.0006": Failed to query the backup data size. "dcs.08.0007": Failed to synchronize data during restoration. "dcs.08.0008": The scheduled backup task is not running. The instance is running other tasks.
restore_name	String	Definition: Name of the restoration record. Range: N/A
backup_remark	String	Definition: Description of the backup. Range: N/A
status	String	Definition: Restoration status. Range: waiting restoring succeed failed

Status code: 204

No instance restoration record found.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores?offset={offset}&limit={limit}&begin_Time={begin_Time}&end_Time={end_Time}

Example Responses

Status code: 200

DCS instance restoration records queried.

{
  "restore_record_response" : [ {
    "backup_id" : "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb",
    "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6",
    "backup_name" : "backup_20170718000002",
    "updated_at" : "2017-07-18T21:41:35.182Z",
    "restore_remark" : "doctest",
    "created_at" : "2017-07-18T21:41:20.721Z",
    "progress" : "100.00",
    "error_code" : { },
    "restore_name" : "restore_20170718214120",
    "backup_remark" : { },
    "status" : "succeed"
  } ],
  "total_num" : 1
}