DescribeDisksRequest (tencentcloud-sdk-java 3.0.112 API)

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

public class DescribeDisksRequest
extends AbstractModel

构造器概要

构造器
构造器和说明

DescribeDisksRequest()

构造器
构造器和说明
`DescribeDisksRequest()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String[]`	`getDiskIds()` 获取按照一个或者多个云硬盘ID查询。
`Filter[]`	`getFilters()` 获取过滤条件。
`Integer`	`getLimit()` 获取返回数量，默认为20，最大值为100。
`Integer`	`getOffset()` 获取偏移量，默认为0。
`String`	`getOrder()` 获取输出云盘列表的排列顺序。
`String`	`getOrderField()` 获取云盘列表排序的依据字段。
`Boolean`	`getReturnBindAutoSnapshotPolicy()` 获取云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。
`void`	`setDiskIds(String[] DiskIds)` 设置按照一个或者多个云硬盘ID查询。
`void`	`setFilters(Filter[] Filters)` 设置过滤条件。
`void`	`setLimit(Integer Limit)` 设置返回数量，默认为20，最大值为100。
`void`	`setOffset(Integer Offset)` 设置偏移量，默认为0。
`void`	`setOrder(String Order)` 设置输出云盘列表的排列顺序。
`void`	`setOrderField(String OrderField)` 设置云盘列表排序的依据字段。
`void`	`setReturnBindAutoSnapshotPolicy(Boolean ReturnBindAutoSnapshotPolicy)` 设置云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。
`void`	`toMap(HashMap<String,String> map, String prefix)` 内部实现，用户禁止调用

从类继承的方法 com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DescribeDisksRequest
```
public DescribeDisksRequest()
```
- 方法详细资料
  - getDiskIds
```
public String[] getDiskIds()
```
    获取按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
    
    返回:
    
    DiskIds 按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
  - setDiskIds
```
public void setDiskIds(String[] DiskIds)
```
    设置按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
    
    参数:
    
    DiskIds - 按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。
  - getFilters
```
public Filter[] getFilters()
```
    获取过滤条件。参数不支持同时指定`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表示SSD云硬盘。)
  - 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使用具体的标签键进行替换。

返回:: 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表示SSD云硬盘。)
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)
```
设置过滤条件。参数不支持同时指定`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表示SSD云硬盘。)
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使用具体的标签键进行替换。

类 DescribeDisksRequest

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractModel

从类继承的方法 java.lang.Object

构造器详细资料

DescribeDisksRequest

方法详细资料

getDiskIds

setDiskIds

getFilters

setFilters

getOffset

setOffset

getLimit

setLimit

getOrder

setOrder

getOrderField

setOrderField

getReturnBindAutoSnapshotPolicy

setReturnBindAutoSnapshotPolicy

toMap