Listing DCS Instance Backup Records

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

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

total_num

Integer

Definition:

Number of records returned for instance backup.

Range:

N/A

backup_record_response

Array of BackupRecordResponse objects

Definition:

Array of the backup details.

backup_id

String

Definition:

Backup record ID.

Range:

N/A

period

String

Definition:

Backup execution time.

Range:

N/A

backup_name

String

Definition:

Backup record name.

Range:

N/A

instance_id

String

Definition:

Instance ID.

Range:

N/A

size

Long

Definition:

Size of the backup file (byte).

Range:

N/A

backup_type

String

Definition:

Backup type.

Range:

• manual: manual backup

• auto: automatic backup

created_at

String

Definition:

Time when the backup task is created.

Range:

N/A

updated_at

String

Definition:

Time at which DCS instance backup is completed.

Range:

N/A

progress

String

Definition:

Backup progress.

Range:

N/A

error_code

String

Definition:

Error code displayed for a backup 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.

remark

String

Definition:

Description of DCS instance backup.

Range:

N/A

status

String

Definition:

Backup status.

Range:

• waiting: The task is waiting to begin.

• backuping: DCS instance backup is in progress.

• succeed: DCS instance backup succeeded.

• failed: DCS instance backup failed.

• expired: The backup file has expired.

• deleted: The backup file has been deleted manually.

is_support_restore

String

Definition:

Whether restoration is supported.

Range:

• TRUE: Yes

• FALSE: No

execution_at

String

Definition:

Execution time.

Range:

N/A

backup_format

String

Definition:

Backup type.

Range:

• aof

• rdb

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

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

200

DCS instance backup records queried successfully.

204

No DCS instance backup record is found.

400

Invalid request.

500

Internal service error.