查询备份列表

功能介绍

根据指定条件查询备份列表。

调试

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

URI

● 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_tim e}&mode={mode}

● URI样例

https://dds.cn-north-1.myhuaweicloud.com/

v3/97b026aa9cc4417888c14c84a1ad9860/backups?

instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&be gin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

● 参数说明

表5-100 参数说明

名称 是否必选 描述

project_id 是 租户在某一region下的project ID。

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

接口创建。

backup_id 否 备份ID。

当该字段传入的备份ID归属为自动增量备份 时，实例ID必传。

名称 是否必选 描述 backup_type 否 备份类型。

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

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

● 取值为“Incremental”，表示自动增量备 份。

● 当该字段未传入值时，默认只查询所有的全 量备份，包括自动全备备份和手动全量备 份。当该字段取值为“Incremental”时，实 例ID必传。

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

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

limit 否 查询备份个数上限值。

取值范围：1~100。不传该参数时，默认查询前 100条实例信息。

begin_time 否 查询备份开始的时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。

说明“end_time”有值时，“begin_time”必选。

end_time 否 查询备份开始的结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。

说明“begin_time”有值时，“end_time”必选。

mode 否 实例模式。

取值：

● Sharding

● ReplicaSet

● Single

请求消息

无。

表5-101 要素说明

名称 参数类型 描述

backups Array of objects 备份列表。详情请参见表5-102。

total_count Integer 总记录数。

表5-102 backups 字段数据结构说明

名称 参数类型 描述

id String 备份ID。

name String 备份名称。

instance_id String 备份所属的实例ID，可以调用“查 询实例列表”接口获取。如果未申 请实例，可以调用“创建实例”接 口创建。

instance_name String 备份所属的实例名称。

datastore Object 数据库版本信息。详情请参见表 5-103。

type String 备份类型。

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

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

● 取值为“Incremental”，表示 自动增量备份。

begin_time String 备份开始时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为 UTC时间。

end_time String 备份结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为 UTC时间。

status String 备份状态。取值：

● BUILDING：备份中。

● COMPLETED：备份完成。

● FAILED：备份失败。

● DISABLED：备份删除中。

size Long 备份大小，单位：KB。

description String 备份描述。

表5-103 datastore 字段数据结构说明

名称 参数类型 描述

type String 数据库引擎。

取值：DDS-Community。

version String 支持4.0、3.4和3.2数据库版本。

取值为“4.0”、“3.4”、

“3.2”。

● 响应样例 { "backups": [ {

"id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "backup-test",

"instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name": "cluster-test",

"datastore" : {

"type" : "DDS-Community", "version" : "3.4"

},

"type": "auto",

"begin_time": "2018-08-06 12:41:14", "end_time": "2018-08-06 12:43:14", "status": "COMPLETED",

"size": 2803,

"description": "backup description"

} ],

"total_count":1 }

状态码

详情请参见状态码。

错误码

详情请参见错误码。