查询云硬盘快照列表

功能介绍

查询云硬盘快照列表。

URI

• URI格式

  GET /v3/{project_id}/snapshots

• 参数说明

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

• request filter参数说明

  参数	参数类型	是否必选	描述
  marker	String	否	分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。
  offset	Integer	否	偏移量。 说明： 分页查询快照时使用，与limit配合使用。假如共有30个快照，设置offset为11，limit为10，即为从第12个快照开始查询，一次最多可读取10个快照。
  limit	Integer	否	返回结果个数限制。 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 当租户所有的快照数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v3/xxx/snapshots?limit=50，表示查询第1~50个快照。GET /v3/xxx/snapshots?offset=50&limit=50，表示查询第51~100个快照。
  name	String	否	云硬盘快照名称，不支持模糊匹配。最大支持255个字节。
  sort_dir	String	否	返回结果按照降序或升序排列，默认为“desc”。 降序：desc 升序：asc
  status	String	否	云硬盘快照状态，具体请参见云硬盘快照状态。
  volume_id	String	否	云硬盘快照对应的卷ID。
  name~	String	否	云硬盘名模糊查询，请求版本号为3.31及以上可支持该参数。
  status~	String	否	云硬盘状态模糊查询，请求版本号为3.31及以上可支持该参数。
  volume_id~	String	否	云硬盘快照对应的卷ID模糊查询，请求版本号为3.31及以上可支持该参数。
  sort_key	String	否	基于name做排序查询，sort_key=name， 请求版本号为3.30及以上可支持name关键字，默认按照降序排序。
  with_count	Boolean	否	返回结果增加counts参数，表示查询结果中的快照数量。格式为with_count=true，请求版本号为3.45及以上可支持该参数。 该参数仅可以和表中的marker、limit、sort_key、sort_dir或者offset参数一同使用，不支持和其他过滤参数共用。

请求消息

以查询状态为available的云硬盘快照为例。

• 请求样例

  GET https://{endpoint}/v3/{project_id}/snapshots?status=available

响应消息

• 响应参数

  参数	参数类型	描述
  snapshots	Object	快照信息，请参见•snapshots参数说明。
  snapshots_links	list<map<String,String>>	云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段，返回该字段表示本次查询只查出了部分云硬盘快照信息。
  count	Object	查询返回结果的数量。
  error	Object	出现错误时，返回的错误信息，具体请参见•error参数说明。

• snapshots参数说明

  参数	参数类型	描述
  id	String	云硬盘快照ID。
  status	String	云硬盘快照的状态，具体请参见云硬盘快照状态。
  name	String	云硬盘快照名称。
  description	String	云硬盘快照描述信息。
  created_at	String	云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  metadata	Object	云硬盘快照的元数据信息。 如果元数据中包含__system__enableActive字段，则表示该快照为云服务器创建备份时自动生成的快照。
  volume_id	String	快照所属的云硬盘ID。
  size	Integer	云硬盘快照大小，单位为GB。
  updated_at	String	快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

• error参数说明

  参数	参数类型	描述
  message	String	出现错误时，返回的错误消息。
  code	String	出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码。

• 响应样例

  {
      "count": 4, 
      "snapshots": [
          {
              "created_at": "2016-02-16T16:54:14.981520", 
              "description": null, 
              "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", 
              "metadata": { }, 
              "name": "test01", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:19.475397", 
              "description": null, 
              "id": "83be494d-329e-4a78-8ac5-9af900f48b95", 
              "metadata": { }, 
              "name": "test02", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:24.367414", 
              "description": null, 
              "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e", 
              "metadata": { }, 
              "name": "test03", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:29.766740", 
              "description": null, 
              "id": "4c29796a-8cf4-4482-9afc-e66da9a81240", 
              "metadata": { }, 
              "name": "test04", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }
      ], 
      "snapshots_links": null
  }

  或

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

  其中error是泛指的错误，有badRequest、itemNotFound等，如报错：

  {
      "itemNotFound": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

状态码

• 正常

  200

错误码

请参考错误码。