Class: TencentCloud::Cbs::V20170312::DescribeDisksRequest

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

Overview

DescribeDisks请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DescribeDisksRequest.



1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/v20170312/models.rb', line 1428

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

Instance Attribute Details

#DiskIds ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def DiskIds
  @DiskIds
end

#Filters ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def Filters
  @Filters
end

#Limit ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def Limit
  @Limit
end

#Offset ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def Offset
  @Offset
end

#Order ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def Order
  @Order
end

#OrderField ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def OrderField
  @OrderField
end

#ReturnBindAutoSnapshotPolicy ⇒ Object

Parameters:

  • Filters: —

    过滤条件。参数不支持同时指定‘DiskIds`和`Filters`。
    <li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
    </li> <li>disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
    </li> <li>portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
    </li> <li>project-id - Array of String - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
    </li> <li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
    </li> <li>disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
    </li> <li>disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
    </li> <li>disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收 | DUMPING：拷贝硬盘中。)
    </li> <li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
    </li> <li>zone - Array of String - 是否必填：否 -（过滤条件）按照(/document/product/213/15753#ZoneInfo)过滤。
    </li> <li>instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
    </li> <li>instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
    </li> <li>tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
    </li> <li>tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
    </li> <li>tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
    </li> <li>dedicated-cluster-id - Array of String - 是否必填：否 -（过滤条件）按照 CDC 独享集群 ID 进行过滤。
    </li> <li>cluster-group-id - String - 是否必填：否 -（过滤条件）按照 集群群组 ID 进行过滤。</li>

  • Limit: —

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

  • OrderField: —

    云盘列表排序的依据字段。取值范围：
    <li>CREATE_TIME：依据云盘的创建时间排序
    </li><li>DEADLINE：依据云盘的到期时间排序
    默认按云盘创建时间排序。</li>

  • Offset: —

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

  • ReturnBindAutoSnapshotPolicy: —

    云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。

  • DiskIds: —

    按照一个或者多个云硬盘ID查询。云硬盘ID形如：‘disk-11112222`，此参数的具体格式可参考API(/document/product/362/15633)的ids.N一节）。参数不支持同时指定‘DiskIds`和`Filters`。

  • Order: —

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



1426
1427
1428
 
# File 'lib/v20170312/models.rb', line 1426

def ReturnBindAutoSnapshotPolicy
  @ReturnBindAutoSnapshotPolicy
end

Instance Method Details

#deserialize(params) ⇒ Object 



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/v20170312/models.rb', line 1438

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