云数据库 GAUSSDB-查询备份列表:URI

时间:2024-12-31 09:12:37

URI

GET https://{Endpoint}/v3.2/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识,用于查询某一实例的备份。

约束限制:

日志备份列表查询时实例ID必选。

取值范围:

严格匹配UUID规则,只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

backup_id

String

参数解释:

备份ID,此参数是实例备份的唯一标识,用于查询某一备份的信息。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符且符合UUID规则。

默认取值

不涉及。

backup_type

String

参数解释:

备份类型。

约束限制:

不涉及。

取值范围:

  • auto:实例级自动全量备份。
  • manual:实例级手动全量备份。

默认取值

不涉及。

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制:

不涉及。

取值范围:

[0, 10^10-1]

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。

约束限制:

不涉及。

取值范围:

[0, 100]

默认取值

默认为100。

begin_time

String

参数解释:

查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。示例:2022-05-09T16:01:10+0800。

约束限制:

可与end_time配合使用,end_time不使用时,查询结果为begin_time之后创建的备份列表,使用end_time时,查询结果为begin_time和end_time之间创建的备份列表。

取值范围:

不涉及。

默认取值

不涉及。

end_time

String

参数解释:

查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。示例:2022-05-09T16:01:10+0800。

约束限制:

可与begin_time配合使用,begin_time不使用时,查询结果为end_time之前创建的备份列表,使用begin_time时,查询结果为begin_time和end_time之间创建的备份列表。

取值范围:

不涉及。

默认取值

不涉及。

support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html