Querying Backups (Recommended)

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

No

String

Instance ID, which can be obtained by calling the API for querying instances. If there are no instances available, create one by calling the API used for creating an instance.

datastore_type

No

String

Database type. The value can be:

• cassandra
• redis
• mongodb
• influxdb

backup_id

No

String

Backup ID.

backup_type

No

String

Backup type, which is case sensitive. The value can be:

• Auto, indicating that this backup is an automatic full backup.
• Manual, indicating that this backup is a manual full backup.
• If this parameter is not transferred, automated and manual full backups, including table-level backups, are both queried by default.

type

No

String

Backup policy type. The value can be:

• Instance, indicating that an instance backup is queried.
• DatabaseTable, indicating that a database or table backup is queried.
• The default value is Instance.

limit

No

Integer

Maximum backup records to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 instances are queried by default.

Minimum value: 1

Maximum value: 100

offset

No

Integer

Index position. The query starts from the next backup creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data. The value must be no less than 0. If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

Minimum value: 0

begin_time

No

String

Start time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset and the default value is left blank by default.

• When end_time is not empty, begin_time is mandatory.

end_time

No

String

End time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset and the default value is left blank by default.

• When begin_time is not empty, end_time is mandatory.

X-Auth-Token

Yes

String

User token.

total_count

Integer

Total backups.

backups

Array of objects

Backup details. For details, see Table 5.

id

String

Backup ID.

description

String

Backup description.

instance_id

String

ID of the instance that the backup is created for.

instance_name

String

Name of the instance that the backup is created for.

datastore

object

DB version information. For details, see Table 6.

name

String

Backup name.

type

String

• Auto: indicates that this backup is an automatic full backup.
• Manual: indicates that this backup is a manual full backup.

size

Double

Backup size, in KB.

status

String

Backup status. The value can be:

• BUILDING, indicating that the backup is in progress.
• COMPLETED, indicating that the backup is completed.
• FAILED, indicating that the backup failed.

begin_time

String

Backup start time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

end_time

String

Backup end time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

database_tables

Array of objects

Database and table information in the backup. For details, see Table 7.

• Keep this parameter empty or ignore it when you query an instance backup.
• Specify this parameter when you query a database or table backup (if any).

type

String

Database type.

version

String

Database version.

database_name

String

Database name.

table_names

Array of strings

Table names.

• If this parameter is empty, database names are queried.
• If this parameter is not empty, table names are queried.