Class: TencentCloud::Lighthouse::V20200324::DescribeDisksRequest

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

Overview

DescribeDisks请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(diskids = nil, filters = nil, limit = nil, offset = nil, orderfield = nil, order = nil) ⇒ DescribeDisksRequest

Returns a new instance of DescribeDisksRequest.



2347
2348
2349
2350
2351
2352
2353
2354
# File 'lib/v20200324/models.rb', line 2347

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

Instance Attribute Details

#DiskIdsObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def DiskIds
  @DiskIds
end

#FiltersObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def Filters
  @Filters
end

#LimitObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def Limit
  @Limit
end

#OffsetObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def Offset
  @Offset
end

#OrderObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def Order
  @Order
end

#OrderFieldObject

disk-id 按照【云硬盘 ID】进行过滤。 类型:String 必选:否 instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 disk-name 按照【云硬盘名称】进行过滤。 类型:String 必选:否 zone 按照【可用区】进行过滤。 类型:String 必选:否 disk-usage 按照【云硬盘类型】进行过滤。 类型:String 必选:否 取值:SYSTEM_DISK(系统盘)或 DATA_DISK(数据盘) disk-state 按照【云硬盘状态】进行过滤。 类型:String 必选:否 取值:参考数据结构Disk中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型:String 必选:否 tag-value 按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

  • DiskIds:

    云硬盘ID列表。可通过DescribeDisks接口返回值字段KeyPairSet获取。列表长度最大值为100。

  • Filters:

    过滤器列表。

  • Limit:

    返回数量,默认为20,最大值为100。

  • Offset:

    偏移量,默认为0。

  • OrderField:

    云硬盘列表排序的依据字段。取值范围:"CREATED_TIME":依据云硬盘的创建时间排序。 "EXPIRED_TIME":依据云硬盘的到期时间排序。"DISK_SIZE":依据云硬盘的大小排序。默认按云硬盘创建时间排序。

  • Order:

    输出云硬盘列表的排列顺序。取值范围:"ASC":升序排列。 "DESC":降序排列。默认按降序排列。



2345
2346
2347
# File 'lib/v20200324/models.rb', line 2345

def OrderField
  @OrderField
end

Instance Method Details

#deserialize(params) ⇒ Object



2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/v20200324/models.rb', line 2356

def deserialize(params)
  @DiskIds = params['DiskIds']
  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']
  @Offset = params['Offset']
  @OrderField = params['OrderField']
  @Order = params['Order']
end