查询备份列表

功能介绍

查询备份列表。

该接口计划于2025-03-31下线，建议及时切换到新接口查询全量备份列表。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

• URI格式

  GET https://{endpoint}/mysql/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}

• URI样例

  GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

• 参数说明

  表1 参数说明

  名称	参数类型	是否必选	说明
  project_id	String	是	租户在某一Region下的project ID。 获取方法请参见获取项目ID。
  instance_id	String	否	实例ID。
  backup_id	String	否	备份ID。
  backup_type	String	否	备份类型，取值： “auto”: 自动全量备份。 “manual”: 手动全量备份。
  offset	String	否	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
  limit	String	否	查询记录数。默认为100，不能为负数，最小值为1，最大值为100。
  begin_time	String	否	查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  end_time	String	否	查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

请求消息

无

响应消息

• 正常响应要素说明

  表2 参数说明

  名称	参数类型	说明
  backups	Array of objects	备份信息。 详情请参见表 backups字段数据结构说明。
  total_count	Integer	总记录数。

  表3 backups字段数据结构说明

  名称	参数类型	说明
  id	String	备份ID。
  name	String	备份名称。
  begin_time	String	备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  end_time	String	备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  status	String	备份状态，取值： BUILDING: 备份中。 COMPLETED: 备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。
  take_up_time	Integer	备份花费时间，（单位：minutes）。
  type	String	备份类型，取值： “auto”: 自动全量备份。 “manual”: 手动全量备份。
  size	Double	备份大小，（单位：MB）。
  datastore	Object	数据库信息。 详情请参见表 datastore字段数据结构说明。
  instance_id	String	实例ID。
  backup_level	String	备份级别。当开启一级备份开关时，返回该参数。取值： 1: 一级备份。 2: 二级备份。 0：备份正在创建中或备份失败。

  表4 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎。
  version	String	数据库版本。

• 正常响应样例

  {
  "backups": [{
  "id": "43e4feaab48f11e89039fa163ebaa7e4br01",
  "name": "GaussDBforMySQL-gauss-e747-20200705185048266",
  "begin_time": "2018-08-06T12:41:14+0800",
  "end_time": "2018-08-06T12:45:14+0800",
  "take_up_time": 2,
  "status": "COMPLETED",
  "type": "auto",
  "size": 2803,
  "datastore": {
  "type": "gaussdb-mysql",
  "version": "8.0"
  },
  "instance_id": "c3ec2c6148ad4d71b1a8411a62df0d3cin07",
  "backup_level": "2"
  }],
  "total_count": 1
  }

状态码

请参见状态码。

错误码

请参见错误码。