查询备份列表

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

否

String

参数解释：

实例ID。可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

datastore_type

否

String

参数解释：

数据库类型。

约束限制：

不涉及。

取值范围：

• cassandra：表示查询GeminiDB Cassandra数据库实例。
• redis：表示GeminiDB Redis查询数据库实例。
• mongodb：表示查询GeminiDB Mongo数据库实例。
• influxdb：表示查询GeminiDB Influx数据库实例。

默认取值：

不涉及。

backup_id

否

String

参数解释：

备份ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

backup_type

否

String

参数解释：

备份类型。

约束限制：

大小写敏感。

取值范围：

• 取值为“Auto”，表示自动全量备份。
• 取值为“Manual”，表示手动全量备份。

默认取值：

当该字段未传入值时，默认只查询所有的全量备份(包含库表级)，包括自动全备备份和手动全量备份。

type

否

String

参数解释：

备份策略类型。

约束限制：

不涉及。

取值范围：

• Instance：表示查询实例级备份。
• DatabaseTable：表示查询库表级备份。

默认取值：

Instance。

limit

否

Integer

参数解释：

查询备份个数上限值。

约束限制：

不涉及。

取值范围：

1-100。

默认取值：

不传该参数时，默认查询前100条实例信息。

offset

否

Integer

参数解释：

索引位置偏移量，表示从指定project ID下最新的备份创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的备份信息。

约束限制：

不涉及。

取值范围：

取值大于或等于0。

默认取值：

不传该参数时，查询偏移量默认为0，表示从最新的备份创建时间对应的备份开始查询。

begin_time

否

String

参数解释：

查询备份开始的时间。

约束限制：

当“end_time”有值时，“begin_time”必选。

取值范围：

为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。

默认取值：

空值。

end_time

否

String

参数解释：

查询备份开始的结束时间。

约束限制：

当“begin_time”有值时，“end_time”必选。

取值范围：

为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。

默认取值：

空值。

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total_count

Integer

参数解释：

备份总数量。

取值范围：

不涉及。

backups

Array of objects

参数解释：

备份详情列表。详情请参考表5。

id

String

参数解释：

备份ID。

取值范围：

不涉及。

description

String

参数解释：

备份描述信息。

取值范围：

不涉及。

instance_id

String

参数解释：

备份所属的实例ID。

取值范围：

不涉及。

instance_name

String

参数解释：

备份所属的实例名称。

取值范围：

不涉及。

datastore

object

参数解释：

数据库版本信息。详情请参考表6。

name

String

参数解释：

备份名称。

取值范围：

不涉及。

type

String

参数解释：

备份类型。

取值范围：

• 取值为“Auto”，表示自动全量备份。
• 取值为“Manual”，表示手动全量备份。

size

Double

参数解释：

备份大小，单位：KB。

取值范围：

不涉及。

status

String

参数解释：

备份状态。

取值范围：

• BUILDING：备份中。
• COMPLETED：备份完成。
• FAILED：备份失败。

begin_time

String

参数解释：

备份开始时间。

约束限制：

为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。

end_time

String

参数解释：

备份结束时间。

约束限制：

为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。

database_tables

Array of objects

参数解释：

备份里的库表信息。详情请参考表7。

约束限制：

• 实例级查询时该字段为空，可忽略。
• 库表级查询时该字段非空（存在库表级备份的话）。

type

String

参数解释：

数据库类型。

取值范围：

不涉及。

version

String

参数解释：

数据库版本。

取值范围：

不涉及。

database_name

String

参数解释：

数据库名称。

取值范围：

不涉及。

table_names

Array of strings

参数解释：

表名称列表。

• table_names为空的时候，表示库级别查询。
• table_names非空的时候，表示表级别查询。