Querying Full Backups

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this 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

instance_id

No

String

Definition:

Instance ID, which uniquely identifies an instance.

Constraints:

N/A

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

Default value:

N/A

backup_id

No

String

Definition:

Backup ID, which uniquely identifies a backup.

Constraints:

N/A

Range:

The value can contain 36 characters with a suffix of br07. Only letters and digits are allowed.

Default value:

N/A

backup_type

No

String

Definition:

Backup type.

Constraints:

N/A

Range:

• auto: automated full backup
• manual: manual full backup

Default value:

N/A

offset

No

String

Definition:

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

Constraints:

The value must be an integer and cannot be a negative number.

Range:

≥0

Default value:

0

limit

No

String

Definition:

Number of records to be queried.

Constraints:

The value must be an integer and cannot be a negative number.

Range:

1–100

Default value:

100

begin_time

No

String

Definition:

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. For example, if the time zone offset is one hour, the value of Z is +0100.

Constraints:

N/A

Range:

The time is earlier than the current time.

Default value:

N/A

end_time

No

String

Definition:

Query 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. For example, if the time zone offset is one hour, the value of Z is +0100.

Constraints:

N/A

Range:

The time is earlier than the current time and later than the start time.

Default value:

N/A

name

No

String

Definition:

Backup name.

Constraints:

N/A

Range:

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

instance_name

No

String

Definition:

Instance name.

Constraints:

N/A

Range:

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

• en-us
• zh-cn

Default value:

en-us

backups

Array of backups objects

Definition:

Backup information.

Range:

N/A

total_count

Long

Definition:

Total number of backup files.

Range:

≥0

id

String

Definition:

Backup ID.

Range:

The value can contain 36 characters with a suffix of br07. Only letters and digits are allowed.

name

String

Definition:

Backup name.

Range:

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

begin_time

String

Definition:

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. For example, if the time zone offset is one hour, the value of Z is +0100.

Range:

N/A

end_time

String

Definition:

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. For example, if the time zone offset is one hour, the value of Z is +0100.

Range:

N/A

status

String

Definition:

Backup status.

Range:

• BUILDING: backup in progress
• COMPLETED: backup completed
• FAILED: backup failed
• AVAILABLE: backup available

take_up_time

Integer

Definition:

Backup duration in minutes.

Range:

≥ 0

type

String

Definition:

Backup type.

Range:

• auto: automated full backup
• manual: manual full backup

size

Long

Definition:

Backup size in MB.

Range:

≥0

datastore

MysqlDatastore object

Definition:

Database information.

instance_id

String

Definition:

Instance ID, which uniquely identifies an instance.

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

instance_name

String

Definition:

Instance name.

Range:

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

backup_level

String

Definition:

Backup level. This parameter is returned when level-1 backup is enabled.

Range:

• 0: Backup being created or creation failed
• 1: level-1 backup
• 2: level-2 backup

description

String

Definition:

Description of the backup file.

Range:

N/A

type

String

Definition:

DB engine.

Range:

gaussdb-mysql

version

String

Definition:

DB version.

Range:

8.0

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.