文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 备份管理/ 查询备份列表
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

查询备份列表

功能介绍

查询备份列表。

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

调试

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

URI

GET /mysql/v3/{project_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

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。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

backups

Array of backups objects

备份信息。

total_count

Number

备份文件的总数。
表5 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

Object

备份状态

枚举值：

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

take_up_time

Integer

备份花费时间(单位：minutes)

type

Object

备份类型

枚举值：

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

size

Number

备份大小，(单位：MB)

datastore

MysqlDatastore object

数据库信息。

instance_id

String

实例ID。

backup_level

Object

备份级别。当开启一级备份开关时，返回该参数。

枚举值：

  • 0：备份正在创建中或者备份失败。
  • 1：一级备份。
  • 2：二级备份。

description

String

备份文件描述信息
表6 MysqlDatastore

参数

参数类型

描述

type

String

数据库引擎，现在只支持gaussdb-mysql

version

String

数据库版本。

数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

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

响应示例

状态码： 200

Success.

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档