DescribeDisksRequest (tencentcloud-sdk-java 3.1.393 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.cbs.v20170312.models.DescribeDisksRequest

public class DescribeDisksRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`DescribeDisksRequest()`
`DescribeDisksRequest(DescribeDisksRequest source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getDiskIds()` Get 按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
`Filter[]`	`getFilters()` Get 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。 disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 \| DATA_DISK：表示数据盘) disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 \| POSTPAID_BY_HOUR：表示后付费，即按量计费。) portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 \| FALSE：表示非弹性云盘。) project-id - Array of Integer - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。 disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。 disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。 disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 \| CLOUD_PREMIUM：表示高性能云硬盘。\| CLOUD_SSD：表示SSD云硬盘 \| CLOUD_HSSD：表示增强型SSD云硬盘。\| CLOUD_TSSD：表示极速型云硬盘。) disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 \| ATTACHING：挂载中 \| ATTACHED：已挂载 \| DETACHING：解挂中 \| EXPANDING：扩容中 \| ROLLBACKING：回滚中 \| TORECYCLE：待回收。) instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。 zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。 instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。 instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。 tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。 tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
`Long`	`getLimit()` Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
`Long`	`getOffset()` Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
`String`	`getOrder()` Get 输出云盘列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。
`String`	`getOrderField()` Get 云盘列表排序的依据字段。取值范围： CREATE_TIME：依据云盘的创建时间排序 DEADLINE：依据云盘的到期时间排序默认按云盘创建时间排序。
`Boolean`	`getReturnBindAutoSnapshotPolicy()` Get 云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。
`void`	`setDiskIds(String[] DiskIds)` Set 按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
`void`	`setFilters(Filter[] Filters)` Set 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。 disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 \| DATA_DISK：表示数据盘) disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 \| POSTPAID_BY_HOUR：表示后付费，即按量计费。) portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 \| FALSE：表示非弹性云盘。) project-id - Array of Integer - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。 disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。 disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。 disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 \| CLOUD_PREMIUM：表示高性能云硬盘。\| CLOUD_SSD：表示SSD云硬盘 \| CLOUD_HSSD：表示增强型SSD云硬盘。\| CLOUD_TSSD：表示极速型云硬盘。) disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 \| ATTACHING：挂载中 \| ATTACHED：已挂载 \| DETACHING：解挂中 \| EXPANDING：扩容中 \| ROLLBACKING：回滚中 \| TORECYCLE：待回收。) instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。 zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。 instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。 instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。 tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。 tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
`void`	`setLimit(Long Limit)` Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
`void`	`setOffset(Long Offset)` Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
`void`	`setOrder(String Order)` Set 输出云盘列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。
`void`	`setOrderField(String OrderField)` Set 云盘列表排序的依据字段。取值范围： CREATE_TIME：依据云盘的创建时间排序 DEADLINE：依据云盘的到期时间排序默认按云盘创建时间排序。
`void`	`setReturnBindAutoSnapshotPolicy(Boolean ReturnBindAutoSnapshotPolicy)` Set 云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DescribeDisksRequest
```
public DescribeDisksRequest()
```
  - DescribeDisksRequest
```
public DescribeDisksRequest(DescribeDisksRequest source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getFilters
```
public Filter[] getFilters()
```
    Get 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。
  - disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)
  - disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)
  - portable - Array of String - 是否必填：否 -（过滤条件）按是否为弹性云盘过滤。 (TRUE：表示弹性云盘 | FALSE：表示非弹性云盘。)
  - project-id - Array of Integer - 是否必填：否 -（过滤条件）按云硬盘所属项目ID过滤。
  - disk-id - Array of String - 是否必填：否 -（过滤条件）按照云硬盘ID过滤。云盘ID形如：`disk-11112222`。
  - disk-name - Array of String - 是否必填：否 -（过滤条件）按照云盘名称过滤。
  - disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：表示SSD云硬盘 | CLOUD_HSSD：表示增强型SSD云硬盘。| CLOUD_TSSD：表示极速型云硬盘。)
  - disk-state - Array of String - 是否必填：否 -（过滤条件）按照云盘状态过滤。(UNATTACHED：未挂载 | ATTACHING：挂载中 | ATTACHED：已挂载 | DETACHING：解挂中 | EXPANDING：扩容中 | ROLLBACKING：回滚中 | TORECYCLE：待回收。)
  - instance-id - Array of String - 是否必填：否 -（过滤条件）按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
  - zone - Array of String - 是否必填：否 -（过滤条件）按照[可用区](/document/product/213/15753#ZoneInfo)过滤。
  - instance-ip-address - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载云主机的内网或外网IP过滤。
  - instance-name - Array of String - 是否必填：否 -（过滤条件）按云盘所挂载的实例名称过滤。
  - tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
  - tag-value - Array of String - 是否必填：否 -（过滤条件）照标签值进行过滤。
  - tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。

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

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

Class DescribeDisksRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDisksRequest

DescribeDisksRequest

Method Detail

getFilters

setFilters

getLimit

setLimit

getOrderField

setOrderField

getOffset

setOffset

getReturnBindAutoSnapshotPolicy

setReturnBindAutoSnapshotPolicy

getDiskIds

setDiskIds

getOrder

setOrder

toMap