
com.tencentcloudapi.cbs.v20170312.models.DescribeDisksRequest Maven / Gradle / Ivy
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.cbs.v20170312.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class DescribeDisksRequest extends AbstractModel {
/**
* 过滤条件。参数不支持同时指定`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使用具体的标签键进行替换。
dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
*/
@SerializedName("Filters")
@Expose
private Filter [] Filters;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* 云盘列表排序的依据字段。取值范围:
CREATE_TIME:依据云盘的创建时间排序
DEADLINE:依据云盘的到期时间排序
默认按云盘创建时间排序。
*/
@SerializedName("OrderField")
@Expose
private String OrderField;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
*/
@SerializedName("ReturnBindAutoSnapshotPolicy")
@Expose
private Boolean ReturnBindAutoSnapshotPolicy;
/**
* 按照一个或者多个云硬盘ID查询。云硬盘ID形如:`disk-11112222`,此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节)。参数不支持同时指定`DiskIds`和`Filters`。
*/
@SerializedName("DiskIds")
@Expose
private String [] DiskIds;
/**
* 输出云盘列表的排列顺序。取值范围:
ASC:升序排列
DESC:降序排列。
*/
@SerializedName("Order")
@Expose
private String Order;
/**
* 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使用具体的标签键进行替换。
dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
* @return 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使用具体的标签键进行替换。
dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
*/
public Filter [] getFilters() {
return this.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使用具体的标签键进行替换。
dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
* @param 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使用具体的标签键进行替换。
dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
*/
public void setFilters(Filter [] Filters) {
this.Filters = Filters;
}
/**
* Get 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
* @return Limit 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
* @param Limit 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
/**
* Get 云盘列表排序的依据字段。取值范围:
CREATE_TIME:依据云盘的创建时间排序
DEADLINE:依据云盘的到期时间排序
默认按云盘创建时间排序。
* @return OrderField 云盘列表排序的依据字段。取值范围:
CREATE_TIME:依据云盘的创建时间排序
DEADLINE:依据云盘的到期时间排序
默认按云盘创建时间排序。
*/
public String getOrderField() {
return this.OrderField;
}
/**
* Set 云盘列表排序的依据字段。取值范围:
CREATE_TIME:依据云盘的创建时间排序
DEADLINE:依据云盘的到期时间排序
默认按云盘创建时间排序。
* @param OrderField 云盘列表排序的依据字段。取值范围:
CREATE_TIME:依据云盘的创建时间排序
DEADLINE:依据云盘的到期时间排序
默认按云盘创建时间排序。
*/
public void setOrderField(String OrderField) {
this.OrderField = OrderField;
}
/**
* Get 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
* @return Offset 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
*/
public Long getOffset() {
return this.Offset;
}
/**
* Set 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
* @param Offset 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* Get 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
* @return ReturnBindAutoSnapshotPolicy 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
*/
public Boolean getReturnBindAutoSnapshotPolicy() {
return this.ReturnBindAutoSnapshotPolicy;
}
/**
* Set 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
* @param ReturnBindAutoSnapshotPolicy 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
*/
public void setReturnBindAutoSnapshotPolicy(Boolean ReturnBindAutoSnapshotPolicy) {
this.ReturnBindAutoSnapshotPolicy = ReturnBindAutoSnapshotPolicy;
}
/**
* Get 按照一个或者多个云硬盘ID查询。云硬盘ID形如:`disk-11112222`,此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节)。参数不支持同时指定`DiskIds`和`Filters`。
* @return DiskIds 按照一个或者多个云硬盘ID查询。云硬盘ID形如:`disk-11112222`,此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节)。参数不支持同时指定`DiskIds`和`Filters`。
*/
public String [] getDiskIds() {
return this.DiskIds;
}
/**
* Set 按照一个或者多个云硬盘ID查询。云硬盘ID形如:`disk-11112222`,此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节)。参数不支持同时指定`DiskIds`和`Filters`。
* @param DiskIds 按照一个或者多个云硬盘ID查询。云硬盘ID形如:`disk-11112222`,此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节)。参数不支持同时指定`DiskIds`和`Filters`。
*/
public void setDiskIds(String [] DiskIds) {
this.DiskIds = DiskIds;
}
/**
* Get 输出云盘列表的排列顺序。取值范围:
ASC:升序排列
DESC:降序排列。
* @return Order 输出云盘列表的排列顺序。取值范围:
ASC:升序排列
DESC:降序排列。
*/
public String getOrder() {
return this.Order;
}
/**
* Set 输出云盘列表的排列顺序。取值范围:
ASC:升序排列
DESC:降序排列。
* @param Order 输出云盘列表的排列顺序。取值范围:
ASC:升序排列
DESC:降序排列。
*/
public void setOrder(String Order) {
this.Order = Order;
}
public DescribeDisksRequest() {
}
/**
* 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.
*/
public DescribeDisksRequest(DescribeDisksRequest source) {
if (source.Filters != null) {
this.Filters = new Filter[source.Filters.length];
for (int i = 0; i < source.Filters.length; i++) {
this.Filters[i] = new Filter(source.Filters[i]);
}
}
if (source.Limit != null) {
this.Limit = new Long(source.Limit);
}
if (source.OrderField != null) {
this.OrderField = new String(source.OrderField);
}
if (source.Offset != null) {
this.Offset = new Long(source.Offset);
}
if (source.ReturnBindAutoSnapshotPolicy != null) {
this.ReturnBindAutoSnapshotPolicy = new Boolean(source.ReturnBindAutoSnapshotPolicy);
}
if (source.DiskIds != null) {
this.DiskIds = new String[source.DiskIds.length];
for (int i = 0; i < source.DiskIds.length; i++) {
this.DiskIds[i] = new String(source.DiskIds[i]);
}
}
if (source.Order != null) {
this.Order = new String(source.Order);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamArrayObj(map, prefix + "Filters.", this.Filters);
this.setParamSimple(map, prefix + "Limit", this.Limit);
this.setParamSimple(map, prefix + "OrderField", this.OrderField);
this.setParamSimple(map, prefix + "Offset", this.Offset);
this.setParamSimple(map, prefix + "ReturnBindAutoSnapshotPolicy", this.ReturnBindAutoSnapshotPolicy);
this.setParamArraySimple(map, prefix + "DiskIds.", this.DiskIds);
this.setParamSimple(map, prefix + "Order", this.Order);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy