获取备份列表

功能介绍

获取备份列表。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/backups

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务的“获取用户Token”接口来获取。

表3 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。取值必须为数字，且不能为负数。
limit	否	Integer	查询个数上限值。取值范围：1~128。不传该参数时，默认值为10。

请求示例

获取备份列表。

GET https://{endpoint}/v3/project_id/configurations?offset=0&limit=10

响应消息

正常响应参数说明

表4 响应Body参数
参数	参数类型	描述
backups	Array of BackupInfo objects	备份信息列表。
offset	Integer	分页参数: 起始值。
limit	Integer	分页参数：每页多少条。
total	Integer	备份信息总数。

表5 BackupInfo
参数	参数类型	描述
id	String	备份ID。
name	String	参数模板名称。
description	String	参数模板描述。
status	String	备份状态。
instance_id	String	实例ID。
instance_name	String	实例名称。
instance_status	String	实例状态。
file_size	Number	备份大小(KB)。
created	String	创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
updated	String	更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
backup_type	String	备份类型： auto_metadata：每天定时任务触发的元数据备份。 metadata：非定时任务触发的元数据备份，例如删实例前进行的元数据备份。

正常响应示例

{
  "backups": [
    {
      "id": "c131f9339****5cdebe350228br09",
      "name": "Backup",
      "description": "auto metadata backup",
      "status": "normal",
      "instance_id": "169f4f2fd6****04385a18ain09",
      "instance_name": "ddm-test",
      "instance_status": "normal",
      "file_size": 5.419922,
      "created": "2025-02-19T02:50:20+0000",
      "updated": "2025-02-19T02:50:37+0000",
      "backup_type": "auto_metadata"
    }
  ],
  "total": 1,
  "offset": 0,
  "limit": 10
}