Querying Backups (v3.1)

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the value, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

No

String

Explanation:

Instance ID, which uniquely identifies an instance and is used to query the backups of an instance.

Restrictions:

This parameter is mandatory when you query log backups.

Value range:

The value is compliant with the UUID format and can contain 32 characters. Only letters and digits are allowed.

Default value:

None

backup_id

No

String

Explanation:

Backup ID, which uniquely identifies an instance backup and is used to query information about a backup.

Restrictions:

None

Value range:

The value is compliant with the UUID format and can contain 36 characters. Only letters and digits are allowed.

Default value:

None

backup_type

No

String

Explanation:

Backup type.

Restrictions:

None

Value range:

• auto: instance-level automated full backup
• manual: instance-level manual full backup

Default value:

None

offset

No

Integer

Explanation:

Index offset. The query starts from the next piece of data indexed by this parameter.

Restrictions:

None

Value range:

[0, 10^10-1]

Default value:

0 (indicating that the query starts from the first data record.)

limit

No

Integer

Explanation:

Number of records to be queried.

Restrictions:

None

Value range:

[0, 100]

Default value:

100

begin_time

No

String

Explanation:

Query start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Example: 2022-05-09T16:01:10+0800.

Restrictions:

This parameter can be used together with end_time. If end_time is not used, the backups created after begin_time are returned. If end_time is used, the backups created between begin_time and end_time are returned.

Value range:

None

Default value:

None

end_time

No

String

Explanation:

Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Example: 2022-05-09T16:01:10+0800.

Restrictions:

This parameter can be used together with begin_time. If begin_time is not used, the backups created before end_time are returned. If begin_time is used, the backups created between begin_time and end_time are returned.

Value range:

None

Default value:

None

backups

Array of objects

Explanation:

Backup information.

For details, see Table 3.

total_count

Long

Explanation:

Total number of backup files.

Value range:

[0, 2^63 - 1]. The actual value depends on the number of backups in the backup list.

id

String

Explanation:

Backup ID, which uniquely identifies a backup.

Value range:

The value can contain 36 characters. Only letters and digits are allowed.

name

String

Explanation:

Backup name.

Value range:

None

description

String

Explanation:

Description of the backup file.

Value range:

The value can contain up to 256 characters but cannot contain carriage return characters. The following special characters are not allowed: ! < " = ' > &

begin_time

String

Explanation:

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Example: 2022-05-09T16:01:10+0800.

Value range:

None

end_time

String

Explanation:

Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Example: 2022-05-09T16:01:10+0800.

Value range:

None

status

String

Explanation:

Backup status.

Value range:

• BUILDING: Backup in progress
• COMPLETED: Backup completed
• FAILED: Backup failed

size

Double

Explanation:

Backup size in MB.

Value range:

The value is determined by the backup size.

type

String

Explanation:

Backup type.

Value range:

• auto: instance-level automated full backup
• manual: instance-level manual full backup

datastore

Object

Explanation:

Database information.

For details, see Table 4.

instance_id

String

Explanation:

ID of the instance to which the backup belongs.

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

type

String

Explanation:

DB engine. The value is case-insensitive and can be:

GaussDB

Value range:

None

version

String

Explanation:

DB engine version. If this parameter is not specified, the latest version is used by default.

Value range:

None