文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 备份与恢复/ 查询备份列表
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询备份列表

接口说明

  • 根据指定条件查询备份列表。
  • 对于集群实例，增量备份文件中存在数据时，查询结果不为空。

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_time}&mode={mode}

表1 参数说明

名称

类型

是否必选

描述

project_id

string

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

否

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

backup_id

string

否

备份ID。

backup_type

string

否

备份类型。

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

offset

Integer

否

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

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

limit

Integer

否

查询备份个数上限值。

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

begin_time

string

否

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

说明：

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

end_time

string

否

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

mode

string

否

实例模式。

取值：

  • Sharding
  • ReplicaSet
  • Single

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

表3 参数说明

名称

参数类型

是否必选

描述

backups

Array of objects

是

备份列表。详情请参见表4。

total_count

Integer

是

总记录数。
表4 backups字段数据结构说明

名称

参数类型

是否必选

描述

id

String

是

备份ID。

name

String

是

备份名称。

instance_id

String

是

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

instance_name

String

是

备份所属的实例名称。

datastore

Object

是

数据库版本信息。详情请参见表5。

type

String

是

备份类型。

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

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 datastore字段数据结构说明

名称

参数类型

是否必选

描述

type

String

是

数据库引擎。

取值：DDS-Community。

version

String

是

数据库版本。支持4.4、4.2、4.0、3.4版本，取值为“4.4”、“4.2”、“4.0”、“3.4”。
  • 响应示例 
    { 
 "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 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 备份与恢复