Querying Backups

project_id

Yes

String

Explanation:

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

No

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

datastore_type

No

String

Explanation:

Database type

Constraints:

N/A

Values:

• cassandra: GeminiDB Cassandra instance
• redis: GeminiDB Redis instance
• mongodb: GeminiDB Mongo instance
• influxdb: GeminiDB Influx instance

Default value:

N/A

backup_id

No

String

Explanation:

Backup ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

backup_type

No

String

Explanation:

Backup type

Constraints:

The value is case sensitive.

Values:

• Auto: automated full backup
• Manual: manual full backup

Default value:

If this parameter is not transferred, all automated and manual full backups (including database- and table-level backups) are queried by default.

type

No

String

Explanation:

Backup policy type

Constraints:

N/A

Values:

• Instance: An instance backup is queried.
• DatabaseTable: A database or table backup is queried.

Default value:

Instance

limit

No

Integer

Explanation:

Maximum backup records to be queried.

Constraints:

N/A

Values:

1 to 100

Default value:

If this parameter is not transferred, the first 100 instances are queried by default.

offset

No

Integer

Explanation:

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.

Constraints:

N/A

Values:

The value must be greater than or equal to 0.

Default value:

If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

begin_time

No

String

Explanation:

Time when a backup query starts

Constraints:

When end_time is not empty, begin_time is mandatory.

Values:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

Default value:

Null

end_time

No

String

Explanation:

Time when a backup query ends

Constraints:

When begin_time is not empty, end_time is mandatory.

Values:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

Default value:

Null

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

total_count

Integer

Explanation:

Total backups.

Values:

N/A

backups

Array of objects

Explanation:

Backup details. For details, see Table 5.

id

String

Explanation:

Backup ID.

Values:

N/A

description

String

Explanation:

Backup description.

Values:

N/A

instance_id

String

Explanation:

ID of the instance that the backup is created for.

Values:

N/A

instance_name

String

Explanation:

Name of the instance that the backup is created for.

Values:

N/A

datastore

object

Explanation:

DB version information. For details, see Table 6.

name

String

Explanation:

Backup name.

Values:

N/A

type

String

Explanation:

Backup type

Values:

• Auto: automated full backup
• Manual: manual full backup

size

Double

Explanation:

Backup size, in KB.

Values:

N/A

status

String

Explanation:

Backup status

Values:

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

begin_time

String

Explanation:

Backup start time

Constraints:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

end_time

String

Explanation:

Backup end time

Constraints:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

database_tables

Array of objects

Explanation:

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

Constraints:

• 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

Explanation:

Database type

Values:

cassandra: GeminiDB Cassandra instance

mongodb: GeminiDB Mongo instance

influxdb: GeminiDB Influx instance

redis: GeminiDB Redis instance

version

String

Explanation:

Database version

Values:

N/A

database_name

String

Explanation:

Database name.

Values:

N/A

table_names

Array of strings

Explanation:

Table names.

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