查询备份概要信息列表（OpenStack原生）

功能介绍

查询备份概要信息列表。

URI

• URI格式

  GET /v2/{project_id}/backups

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID。 获取项目ID方法请参考 获取项目ID

• Request filter参数说明

  参数	是否必选	参数类型	描述
  name	否	string	指定查询的备份名称。用于过滤名称为指定字符串的备份。
  status	否	string	指定查询的备份状态。用于过滤特定状态的备份。可选的值目前只支持：“available”，“error”，“restoring”，“creating”，“deleting”，“error_restoring”。
  offset	否	int	指定查询信息列表的偏移量。
  limit	否	int	指定返回结果个数限制。
  volume_id	否	string	指定查询备份的磁盘ID。用于过滤指定磁盘ID对应的备份。

• 请求示例

  GET /v2/{project_id}/backups?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb

请求

无

响应

• 要素说明

  参数	参数类型	描述
  backups	list<dict>	查询请求返回的备份列表，详情见 backup 参数说明

• backup 说明

  参数	参数类型	描述
  id	string	备份ID。
  links	list<dict>	备份的URL，详情见 links 参数说明
  name	string	备份名称。
  backups_links	list<dict>	表示当前的查询方式下只查询了该租户的一部分备份信息，比如当指定了limit表分页查询或备份个数超过1000个时。

• links 参数说明

  参数	参数类型	描述
  href	string	表示本次查询的最后一个备份的url信息。
  rel	string	rel表示本次查询结果和当前href的关系，next表示还有未查询出来的备份。

• 响应样例

  {
  "backups": [
  {
  "id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
  "links": [
  {
  "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
  "rel": "self"
  },
  {
  "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
  "rel": "bookmark"
  }
  ],
  "name": null
  },
  {
  "id": "b3cf7a16-decc-4beb-8077-682737d94a58",
  "links": [
  {
  "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
  "rel": "self"
  },
  {
  "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
  "rel": "bookmark"
  }
  ],
  "name": null
  }
  ],
  "backups_links": [
      {
        "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
        "rel": "next"
      }
    ]
  }

状态码

• 正常

  200

• 异常

  状态码	说明
  400 Bad Request	服务器未能处理请求。
  401 Unauthorized	被请求的页面需要用户名和密码。
  403 Forbidden	对被请求页面的访问被禁止。
  404 Not Found	服务器无法找到被请求的页面。
  405 Method Not Allowed	请求中指定的方法不被允许。
  406 Not Acceptable	服务器生成的响应无法被客户端所接受。
  407 Proxy Authentication Required	用户必须首先使用代理服务器进行验证，这样请求才会被处理。
  408 Request Timeout	请求超出了服务器的等待时间。
  409 Conflict	由于冲突，请求无法被完成。
  500 Internal Server Error	请求未完成。服务异常。
  501 Not Implemented	请求未完成。服务器不支持所请求的功能。
  502 Bad Gateway	请求未完成。服务器从上游服务器收到一个无效的响应。
  503 Service Unavailable	请求未完成。系统暂时异常。
  504 Gateway Timeout	网关超时。

错误码

请参考错误码。