Package com.tencentcloudapi.cbs.v20170312.models

Class DescribeSnapshotsRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Filter[] getFilters()
      Get 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。
      snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。
      snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。
      snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)
      disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)
      project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
      disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建快照的云硬盘ID过滤。
      zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
      encrypt - Array of String - 是否必填：否 -（过滤条件）按是否加密盘快照过滤。 (TRUE：表示加密盘快照 | FALSE：表示非加密盘快照。) snapshot-type- Array of String - 是否必填：否 -（过滤条件）根据snapshot-type指定的快照类型查询对应的快照。 (SHARED_SNAPSHOT：表示共享过来的快照 | PRIVATE_SNAPSHOT：表示自己私有快照。)
      Long getLimit()
      Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
      Long getOffset()
      Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
      String getOrder()
      Get 输出云盘列表的排列顺序。取值范围：
      ASC：升序排列
      DESC：降序排列。
      String getOrderField()
      Get 快照列表排序的依据字段。取值范围：
      CREATE_TIME：依据快照的创建时间排序
      默认按创建时间排序。
      String[] getSnapshotIds()
      Get 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
      void setFilters​(Filter[] Filters)
      Set 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。
      snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。
      snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。
      snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)
      disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)
      project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
      disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建快照的云硬盘ID过滤。
      zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
      encrypt - Array of String - 是否必填：否 -（过滤条件）按是否加密盘快照过滤。 (TRUE：表示加密盘快照 | FALSE：表示非加密盘快照。) snapshot-type- Array of String - 是否必填：否 -（过滤条件）根据snapshot-type指定的快照类型查询对应的快照。 (SHARED_SNAPSHOT：表示共享过来的快照 | PRIVATE_SNAPSHOT：表示自己私有快照。)
      void setLimit​(Long Limit)
      Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
      void setOffset​(Long Offset)
      Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
      void setOrder​(String Order)
      Set 输出云盘列表的排列顺序。取值范围：
      ASC：升序排列
      DESC：降序排列。
      void setOrderField​(String OrderField)
      Set 快照列表排序的依据字段。取值范围：
      CREATE_TIME：依据快照的创建时间排序
      默认按创建时间排序。
      void setSnapshotIds​(String[] SnapshotIds)
      Set 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • DescribeSnapshotsRequest

        public DescribeSnapshotsRequest()

      • DescribeSnapshotsRequest

        public DescribeSnapshotsRequest​(DescribeSnapshotsRequest source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

    • Method Detail

      • getSnapshotIds

        public String[] getSnapshotIds()
        Get 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
        Returns:
        SnapshotIds 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

      • setSnapshotIds

        public void setSnapshotIds​(String[] SnapshotIds)
        Set 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
        Parameters:
        SnapshotIds - 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

      • getFilters

        public Filter[] getFilters()
        Get 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。
      • snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。
      • snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。
      • snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)
      • disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)
      • project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
      • disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建快照的云硬盘ID过滤。
      • zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
      • encrypt - Array of String - 是否必填：否 -（过滤条件）按是否加密盘快照过滤。 (TRUE：表示加密盘快照 | FALSE：表示非加密盘快照。)
      • snapshot-type- Array of String - 是否必填：否 -（过滤条件）根据snapshot-type指定的快照类型查询对应的快照。 (SHARED_SNAPSHOT：表示共享过来的快照 | PRIVATE_SNAPSHOT：表示自己私有快照。)
Returns:
Filters 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。
  • snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。
  • snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。
  • snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)
  • disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)
  • project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
  • disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建快照的云硬盘ID过滤。
  • zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
  • encrypt - Array of String - 是否必填：否 -（过滤条件）按是否加密盘快照过滤。 (TRUE：表示加密盘快照 | FALSE：表示非加密盘快照。)
  • snapshot-type- Array of String - 是否必填：否 -（过滤条件）根据snapshot-type指定的快照类型查询对应的快照。 (SHARED_SNAPSHOT：表示共享过来的快照 | PRIVATE_SNAPSHOT：表示自己私有快照。)
    • Parameters:
    Filters - 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。
  • snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。
  • snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。
  • snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)
  • disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)
  • project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
  • disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建快照的云硬盘ID过滤。
  • zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
  • encrypt - Array of String - 是否必填：否 -（过滤条件）按是否加密盘快照过滤。 (TRUE：表示加密盘快照 | FALSE：表示非加密盘快照。)
  • snapshot-type- Array of String - 是否必填：否 -（过滤条件）根据snapshot-type指定的快照类型查询对应的快照。 (SHARED_SNAPSHOT：表示共享过来的快照 | PRIVATE_SNAPSHOT：表示自己私有快照。)