云数据库 GeminiDB-查询备份列表(推荐):URI

时间:2025-02-12 15:04:07

URI

GET https://{Endpoint}/v3.1/{project_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释:

实例ID。

约束限制:

可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

取值范围:

不涉及。

默认取值:

不涉及。

datastore_type

String

参数解释:

数据库类型。

约束限制:

不涉及。

取值范围:

  • cassandra
  • redis
  • mongodb
  • influxdb

默认取值:

不涉及。

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指时区偏移量,默认为空。

默认取值:

空值。

support.huaweicloud.com/api-nosql/nosql_05_0211.html