文档首页/ 云数据库 GaussDB/ API参考/ 历史API/ 备份管理/ 查询备份列表
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

查询备份列表

功能介绍

获取备份列表。

接口约束

该接口仅支持查询GaussDB的手动全量备份及自动全量备份。

调试

您可以在API Explorer中调试该接口。

URI

GET https://{Endpoint}/v3/{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，此参数是用户创建实例的唯一标识，用于查询某一实例的备份。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为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之间创建的备份列表。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无。

响应参数

表2 响应参数

参数

参数类型

描述

backups

Array of objects

参数解释：

备份信息。

详情请参见表3。

total_count

Long

参数解释：

备份文件的总数。

取值范围：

[0, 2^63 - 1]，实际总数取决于备份列表个数。
表3 backups字段数据结构说明

参数

参数类型

描述

id

String

参数解释：

备份ID。

取值范围：

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

name

String

参数解释：

备份名称。

取值范围：

不涉及。

description

String

参数解释：

备份文件描述信息。

取值范围：

不超过256个字符，且不能包含回车和 ! < " = ' > &这些特殊字符。

begin_time

String

参数解释：

备份开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例：2022-05-09T16:01:10+0800。

取值范围：

不涉及。

end_time

String

参数解释：

备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

示例2022-05-09T16:01:10+0800。

取值范围：

不涉及。

status

String

参数解释：

备份状态。

取值范围：

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

size

Double

参数解释：

备份大小(单位：MB)。

取值范围：

由备份大小决定。

type

String

参数解释：

备份类型。

取值范围：

  • auto：自动全量备份。
  • manual：手动全量备份。

datastore

Object

参数解释：

数据库信息。

详情请参见表4

instance_id

String

参数解释：

实例ID。表明备份属于哪个实例。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。
表4 datastore字段数据结构说明

参数

参数类型

描述

type

String

参数解释：

数据库引擎，不区分大小写，取值如下：

GaussDB。

取值范围：

不涉及。

version

String

参数解释：

数据库版本。不填时，默认为当前最新版本。

数据库支持版本可根据查询数据库引擎的版本接口获取。

数据库版本。不填时，默认为当前最新版本。

数据库支持版本可根据查询数据库引擎的版本接口获取。

取值范围：

不涉及。

请求示例

  • 查询所有备份列表 
    https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups
  • 根据指定条件查询实例列表 
    https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&backup_id=88be1234c5a64ceba42b42da89310111br14&backup_type=auto&begin_time=2022-05-09T16:15:50+0800&end_time=2022-05-09T16:20:45+0800&limit=1&offset=1

响应示例

{
    "backups": [
        {
            "id": "a696cd25e4fc453aa503650225cece8bbr14",
            "name": "GaussDB-hly-ha-20220509080110906",
            "description": null,
            "status": "FAILED",
            "size": 0.0,
            "type": "auto",
            "datastore": {
                "type": "GaussDB",
                "version": "1.4"
            },
            "begin_time": "2022-05-09T16:01:10+0800",
            "end_time": "2022-05-09T16:04:31+0800",
            "instance_id": "164abc6d35114095bb849d007b19db3bin14"
        },
        {
            "id": "5651c62a7f12461c98020dd3abfe24ccbr14",
            "name": "GaussDB-hly-master-20220509022658257",
            "description": null,
            "status": "FAILED",
            "size": 0.0,
            "type": "auto",
            "datastore": {
                "type": "GaussDB",
                "version": "1.4"
            },
            "begin_time": "2022-05-09T10:26:58+0800",
            "end_time": "2022-05-09T10:30:17+0800",
            "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
        }
	],
    "total_count": 167
}

状态码

错误码

请参见错误码。

父主题： 备份管理

相关文档