com.tencentcloudapi.cbs.v20170312.models

Class DescribeDisksRequest

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

Modifier and Type	Method and Description
String[]	getDiskIds() Get Query by one or more cloud disk IDs, such as `disk-11112222`.
Filter[]	getFilters() Get Filters.
Long	getLimit() Get Number of results to be returned.
Long	getOffset() Get Offset.
String	getOrder() Get Outputs the ordering of the cloud disk list.
String	getOrderField() Get The field by which the cloud disk list is sorted.
Boolean	getReturnBindAutoSnapshotPolicy() Get Whether the ID of the periodic snapshot policy bound to the cloud disk needs to be returned in the cloud disk details.
void	setDiskIds(String[] DiskIds) Set Query by one or more cloud disk IDs, such as `disk-11112222`.
void	setFilters(Filter[] Filters) Set Filters.
void	setLimit(Long Limit) Set Number of results to be returned.
void	setOffset(Long Offset) Set Offset.
void	setOrder(String Order) Set Outputs the ordering of the cloud disk list.
void	setOrderField(String OrderField) Set The field by which the cloud disk list is sorted.
void	setReturnBindAutoSnapshotPolicy(Boolean ReturnBindAutoSnapshotPolicy) Set Whether the ID of the periodic snapshot policy bound to the cloud disk needs to be returned in the cloud disk details.
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

getDiskIds

public String[] getDiskIds()

Get Query by one or more cloud disk IDs, such as `disk-11112222`. For the format of this parameter, please see the ids.N section of the API [Introduction](https://intl.cloud.tencent.com/document/product/362/15633?from_cn_redirect=1). This parameter does not support specifying both `DiskIds` and `Filters`.

Returns:

DiskIds Query by one or more cloud disk IDs, such as `disk-11112222`. For the format of this parameter, please see the ids.N section of the API [Introduction](https://intl.cloud.tencent.com/document/product/362/15633?from_cn_redirect=1). This parameter does not support specifying both `DiskIds` and `Filters`.

setDiskIds

public void setDiskIds(String[] DiskIds)

Set Query by one or more cloud disk IDs, such as `disk-11112222`. For the format of this parameter, please see the ids.N section of the API [Introduction](https://intl.cloud.tencent.com/document/product/362/15633?from_cn_redirect=1). This parameter does not support specifying both `DiskIds` and `Filters`.

Parameters:

DiskIds - Query by one or more cloud disk IDs, such as `disk-11112222`. For the format of this parameter, please see the ids.N section of the API [Introduction](https://intl.cloud.tencent.com/document/product/362/15633?from_cn_redirect=1). This parameter does not support specifying both `DiskIds` and `Filters`.

getFilters

public Filter[] getFilters()

Get Filters. You cannot specify `DiskIds` and `Filters` at the same time.

disk-usage - Array of String - Optional - Filters by cloud disk type. (SYSTEM_DISK: system disk | DATA_DISK: data disk)
disk-charge-type - Array of String - Optional - Filters by cloud disk billing method. (POSTPAID_BY_HOUR: pay-as-you-go)
portable - Array of String- Optional - Filters by whether the cloud disk is elastic or not. (TRUE: elastic | FALSE: non-elastic)
project-id - Array of Integer - Optional - Filters by the ID of the project to which a cloud disk belongs.
disk-id - Array of String - Optional - Filters by cloud disk ID, such as `disk-11112222`.
disk-name - Array of String - Optional - Filters by cloud disk name.
disk-type - Array of String - Optional - Filters by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk.)
disk-state - Array of String - Optional - Filters by cloud disk state. (UNATTACHED: not mounted | ATTACHING: being mounted | ATTACHED: mounted | DETACHING: being unmounted | EXPANDING: being expanded | ROLLBACKING: being rolled back | TORECYCLE: to be repossessed.)
instance-id - Array of String - Optional - Filters by the ID of the CVM instance on which a cloud disk is mounted. You can use this parameter to query the cloud disks mounted on specific CVMs.
zone - Array of String - Optional - Filters by [availability zone](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo)
instance-ip-address - Array of String - Optional - Filters by the private or public IP of the CVM on which a cloud disk is mounted.
instance-name - Array of String - Optional - Filters by the name of the instance on which a cloud disk is mounted.
tag-key - Array of String - Optional - Filters by tag key.
tag-value - Array of String - Optional - Filters by tag value.
tag:tag-key - Array of String - Optional - Filters by tag key-value pair. Please replace `tag-key` with a specific tag key.

Returns:

Filters Filters. You cannot specify `DiskIds` and `Filters` at the same time.

disk-usage - Array of String - Optional - Filters by cloud disk type. (SYSTEM_DISK: system disk | DATA_DISK: data disk)

disk-charge-type - Array of String - Optional - Filters by cloud disk billing method. (POSTPAID_BY_HOUR: pay-as-you-go)

portable - Array of String- Optional - Filters by whether the cloud disk is elastic or not. (TRUE: elastic | FALSE: non-elastic)

project-id - Array of Integer - Optional - Filters by the ID of the project to which a cloud disk belongs.

disk-id - Array of String - Optional - Filters by cloud disk ID, such as `disk-11112222`.

disk-name - Array of String - Optional - Filters by cloud disk name.

disk-type - Array of String - Optional - Filters by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk.)

disk-state - Array of String - Optional - Filters by cloud disk state. (UNATTACHED: not mounted | ATTACHING: being mounted | ATTACHED: mounted | DETACHING: being unmounted | EXPANDING: being expanded | ROLLBACKING: being rolled back | TORECYCLE: to be repossessed.)

instance-id - Array of String - Optional - Filters by the ID of the CVM instance on which a cloud disk is mounted. You can use this parameter to query the cloud disks mounted on specific CVMs.

zone - Array of String - Optional - Filters by [availability zone](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo)

instance-ip-address - Array of String - Optional - Filters by the private or public IP of the CVM on which a cloud disk is mounted.

instance-name - Array of String - Optional - Filters by the name of the instance on which a cloud disk is mounted.

tag-key - Array of String - Optional - Filters by tag key.

tag-value - Array of String - Optional - Filters by tag value.

tag:tag-key - Array of String - Optional - Filters by tag key-value pair. Please replace `tag-key` with a specific tag key.

setFilters

public void setFilters(Filter[] Filters)

Set Filters. You cannot specify `DiskIds` and `Filters` at the same time.

disk-usage - Array of String - Optional - Filters by cloud disk type. (SYSTEM_DISK: system disk | DATA_DISK: data disk)
disk-charge-type - Array of String - Optional - Filters by cloud disk billing method. (POSTPAID_BY_HOUR: pay-as-you-go)
portable - Array of String- Optional - Filters by whether the cloud disk is elastic or not. (TRUE: elastic | FALSE: non-elastic)
project-id - Array of Integer - Optional - Filters by the ID of the project to which a cloud disk belongs.
disk-id - Array of String - Optional - Filters by cloud disk ID, such as `disk-11112222`.
disk-name - Array of String - Optional - Filters by cloud disk name.
disk-type - Array of String - Optional - Filters by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk.)
disk-state - Array of String - Optional - Filters by cloud disk state. (UNATTACHED: not mounted | ATTACHING: being mounted | ATTACHED: mounted | DETACHING: being unmounted | EXPANDING: being expanded | ROLLBACKING: being rolled back | TORECYCLE: to be repossessed.)
instance-id - Array of String - Optional - Filters by the ID of the CVM instance on which a cloud disk is mounted. You can use this parameter to query the cloud disks mounted on specific CVMs.
zone - Array of String - Optional - Filters by [availability zone](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo)
instance-ip-address - Array of String - Optional - Filters by the private or public IP of the CVM on which a cloud disk is mounted.
instance-name - Array of String - Optional - Filters by the name of the instance on which a cloud disk is mounted.
tag-key - Array of String - Optional - Filters by tag key.
tag-value - Array of String - Optional - Filters by tag value.
tag:tag-key - Array of String - Optional - Filters by tag key-value pair. Please replace `tag-key` with a specific tag key.