查询备份列表

功能介绍

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

URI

• URI格式

  GET /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	是	租户在某一region下的project ID。
  instance_id	否	实例ID。
  backup_id	否	备份ID。
  backup_type	否	备份类型。 取值为“Auto”，表示自动全量备份。 取值为“Manual”，表示手动全量备份。
  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

请求消息

• 请求头

  GET https://DDS的Endpoint/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

• 请求体

  N/A

响应消息

• 要素说明

  表2 要素说明

  名称	参数类型	描述
  backups	Array of objects	备份列表。详情请参见表3。
  total_count	Integer	总记录数。

  表3 backups字段数据结构说明

  名称	参数类型	描述
  id	String	备份ID。
  name	String	备份名称。
  instance_id	String	备份所属的实例ID。
  instance_name	String	备份所属的实例名称。
  datastore	Object	数据库版本信息。详情请参见表4。
  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	备份描述。

  表4 datastore字段数据结构说明

  名称	参数类型	描述
  type	String	数据库引擎。 取值：DDS-Community。
  version	String	支持4.0和3.4数据库版本。取值为“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 
  }

状态码

详情请参见状态码。

错误码

详情请参见错误码。