Class: TencentCloud::Cbs::V20170312::DescribeSnapshotsRequest

Inherits:

TencentCloud::Common::AbstractModel

Object
TencentCloud::Common::AbstractModel
TencentCloud::Cbs::V20170312::DescribeSnapshotsRequest

show all

Defined in:: lib/v20170312/models.rb

Overview

DescribeSnapshots请求参数结构体

Instance Attribute Summary collapse

#Filters ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.
#Limit ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.
#Offset ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.
#Order ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.
#OrderField ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.
#SnapshotIds ⇒ Object

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul> <li>ASC：升序排列</li> <li>DESC：降序排列。</li> </ul>.

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(snapshotids = nil, filters = nil, limit = nil, orderfield = nil, offset = nil, order = nil) ⇒ DescribeSnapshotsRequest constructor

A new instance of DescribeSnapshotsRequest.

Constructor Details

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

Returns a new instance of DescribeSnapshotsRequest.

# File 'lib/v20170312/models.rb', line 1703

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

#Filters ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def Filters
  @Filters
end

#Limit ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def Limit
  @Limit
end

#Offset ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def Offset
  @Offset
end

#Order ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def Order
  @Order
end

#OrderField ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def OrderField
  @OrderField
end

#SnapshotIds ⇒ `Object`

<ul> <li>CREATE_TIME：依据快照的创建时间排序</li> <li>默认按创建时间排序</li> </ul> <ul>

<li>ASC：升序排列</li>
<li>DESC：降序排列。</li>

</ul>

Parameters:

SnapshotIds: —

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

过滤条件。参数不支持同时指定SnapshotIds和Filters。
<ul><li>snapshot-id<ul><li>按照云硬盘快照ID进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-name<ul><li>按照云硬盘快照名称进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-state<ul><li>按照云硬盘快照状态进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>NORMAL：正常 </li><li>CREATING：创建中 </li><li>ROLLBACKING：回滚中 </li><li>COPYING_FROM_REMOTE：跨地域复制中 </li><li>CHECKING_COPIED：复制校验中</li><li>TORECYCLE：待回收</li></ul></li></ul></li><li>disk-usage<ul><li>按照云硬盘使用用途进行过滤</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SYSTEM_DISK：代表系统盘</li><li>DATA_DISK：代表数据盘</li></ul></li></ul></li><li>project-id<ul><li>按云硬盘所属项目ID过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>disk-id<ul><li>按照云硬盘ID进行过滤，一次最多只能传入10个值</li><li>类型：String</li><li>必选：否</li></ul></li><li>encrypt<ul><li>按是否加密进行过滤</li><li>类型：String</li><li>必选：否</li></ul></li><li>snapshot-type<ul><li>按快照归属类型查询</li><li>类型：String</li><li>必选：否</li><li>取值范围：<ul><li>SHARED_SNAPSHOT：表示共享过来的快照</li><li>PRIVATE_SNAPSHOT：表示自己的私有快照</li></ul></li></ul></li></ul>
Limit: —

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

快照列表排序的依据字段。取值范围：
Offset: —

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

输出云盘列表的排列顺序。取值范围：



1701
1702
1703

# File 'lib/v20170312/models.rb', line 1701

def SnapshotIds
  @SnapshotIds
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20170312/models.rb', line 1712

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

Class: TencentCloud::Cbs::V20170312::DescribeSnapshotsRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Instance Attribute Details

#Filters ⇒ Object

#Limit ⇒ Object

#Offset ⇒ Object

#Order ⇒ Object

#OrderField ⇒ Object

#SnapshotIds ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

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

#Filters ⇒ `Object`

#Limit ⇒ `Object`

#Offset ⇒ `Object`

#Order ⇒ `Object`

#OrderField ⇒ `Object`

#SnapshotIds ⇒ `Object`

#deserialize(params) ⇒ `Object`