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
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.
#Limit ⇒ Object
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.
#Offset ⇒ Object
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.
#Order ⇒ Object
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.
#OrderField ⇒ Object
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.
#SnapshotIds ⇒ Object
- CREATE_TIME：依据快照的创建时间排序
- 默认按创建时间排序
- ASC：升序排列
- DESC：降序排列。
.

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 1748

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`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def Filters
  @Filters
end

#Limit ⇒ `Object`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def Limit
  @Limit
end

#Offset ⇒ `Object`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def Offset
  @Offset
end

#Order ⇒ `Object`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def Order
  @Order
end

#OrderField ⇒ `Object`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def OrderField
  @OrderField
end

#SnapshotIds ⇒ `Object`

CREATE_TIME：依据快照的创建时间排序
默认按创建时间排序

ASC：升序排列
DESC：降序排列。

Parameters:

SnapshotIds: —
要查询快照的ID列表。参数不支持同时指定SnapshotIds和Filters。
Filters: —
过滤条件。参数不支持同时指定SnapshotIds和Filters。
- snapshot-id
  - 按照云硬盘快照ID进行过滤
  - 类型：String
  - 必选：否
- snapshot-name
  - 按照云硬盘快照名称进行过滤
  - 类型：String
  - 必选：否
- snapshot-state
  - 按照云硬盘快照状态进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
- disk-usage
  - 按照云硬盘使用用途进行过滤
  - 类型：String
  - 必选：否
  - 取值范围：
    - SYSTEM_DISK：代表系统盘
    - DATA_DISK：代表数据盘
- project-id
  - 按云硬盘所属项目ID过滤
  - 类型：String
  - 必选：否
- disk-id
  - 按照云硬盘ID进行过滤，一次最多只能传入10个值
  - 类型：String
  - 必选：否
- encrypt
  - 按是否加密进行过滤
  - 类型：String
  - 必选：否
- snapshot-type
  - 按快照归属类型查询
  - 类型：String
  - 必选：否
  - 取值范围：
    - SHARED_SNAPSHOT：表示共享过来的快照
    - PRIVATE_SNAPSHOT：表示自己的私有快照
Limit: —
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
OrderField: —
快照列表排序的依据字段。取值范围：
Offset: —
偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
Order: —
输出云盘列表的排列顺序。取值范围：



1746
1747
1748

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

def SnapshotIds
  @SnapshotIds
end

Instance Method Details

#deserialize(params) ⇒ `Object`

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

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`