Class: TencentCloud::Ecm::V20190719::DescribeSnapshotsRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190719/models.rb

Overview

DescribeSnapshots请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(snapshotids = nil, filters = nil, limit = nil, orderfield = nil, offset = nil, order = nil) ⇒ DescribeSnapshotsRequest

Returns a new instance of DescribeSnapshotsRequest.



4531
4532
4533
4534
4535
4536
4537
4538
# File 'lib/v20190719/models.rb', line 4531

def initialize(snapshotids=nil, filters=nil, limit=nil, orderfield=nil, offset=nil, order=nil)
  @SnapshotIds = snapshotids
  @Filters = filters
  @Limit = limit
  @OrderField = orderfield
  @Offset = offset
  @Order = order
end

Instance Attribute Details

#FiltersObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def Filters
  @Filters
end

#LimitObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def Limit
  @Limit
end

#OffsetObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def Offset
  @Offset
end

#OrderObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def Order
  @Order
end

#OrderFieldObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def OrderField
  @OrderField
end

#SnapshotIdsObject

<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)

Parameters:

  • SnapshotIds:

    要查询快照的ID列表。参数不支持同时指定‘SnapshotIds`和`Filters`。

  • Filters:

    过滤条件。参数不支持同时指定‘SnapshotIds`和`Filters`。
    <li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。
    <li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
    <li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
    <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
    <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
    <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
    <li>zone - Array of String - 是否必填:否 -(过滤条件)按照(/document/product/213/15753#ZoneInfo)过滤。
    <li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)

  • Limit:

    返回数量,默认为20,最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

  • OrderField:

    快照列表排序的依据字段。取值范围:
    <li>CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。

  • Offset:

    偏移量,默认为0。关于‘Offset`的更进一步介绍请参考API(/document/product/362/15633)中的相关小节。

  • Order:

    输出云盘列表的排列顺序。取值范围:
    <li>ASC:升序排列
    <li>DESC:降序排列。



4529
4530
4531
# File 'lib/v20190719/models.rb', line 4529

def SnapshotIds
  @SnapshotIds
end

Instance Method Details

#deserialize(params) ⇒ Object



4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'lib/v20190719/models.rb', line 4540

def deserialize(params)
  @SnapshotIds = params['SnapshotIds']
  unless params['Filters'].nil?
    @Filters = []
    params['Filters'].each do |i|
      filter_tmp = Filter.new
      filter_tmp.deserialize(i)
      @Filters << filter_tmp
    end
  end
  @Limit = params['Limit']
  @OrderField = params['OrderField']
  @Offset = params['Offset']
  @Order = params['Order']
end