com.tencentcloudapi.lighthouse.v20200324.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lighthouse.v20200324.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeInstancesRequest()
DescribeInstancesRequest(DescribeInstancesRequest 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
Filter[]	getFilters() Get 过滤器列表。 instance-name按照【实例名称】进行过滤。 类型：String 必选：否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否 zone按照【可用区】进行过滤。 类型：String 必选：否 instance-state按照【实例状态】进行过滤。 类型：String 必选：否 tag-key按照【标签键】进行过滤。 类型：String 必选：否 tag-value按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
String[]	getInstanceIds() Get 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
Long	getLimit() Get 返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
Long	getOffset() Get 偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
String	getOrder() Get 输出实例列表的排列顺序。取值范围： "ASC"：升序排列。 "DESC"：降序排列。 默认按升序排序。当传入该字段时，必须指定OrderField。
String	getOrderField() Get 指定排序字段 。取值范围： "EXPIRED_TIME"：依据实例的到期时间排序。 不传入此字段时, 优先返回实例状态为“待回收”的实例, 其余实例以“创建时间”倒序返回。
void	setFilters(Filter[] Filters) Set 过滤器列表。 instance-name按照【实例名称】进行过滤。 类型：String 必选：否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否 zone按照【可用区】进行过滤。 类型：String 必选：否 instance-state按照【实例状态】进行过滤。 类型：String 必选：否 tag-key按照【标签键】进行过滤。 类型：String 必选：否 tag-value按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
void	setInstanceIds(String[] InstanceIds) Set 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
void	setLimit(Long Limit) Set 返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
void	setOffset(Long Offset) Set 偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
void	setOrder(String Order) Set 输出实例列表的排列顺序。取值范围： "ASC"：升序排列。 "DESC"：降序排列。 默认按升序排序。当传入该字段时，必须指定OrderField。
void	setOrderField(String OrderField) Set 指定排序字段 。取值范围： "EXPIRED_TIME"：依据实例的到期时间排序。 不传入此字段时, 优先返回实例状态为“待回收”的实例, 其余实例以“创建时间”倒序返回。
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescribeInstancesRequest

public DescribeInstancesRequest()

DescribeInstancesRequest

public DescribeInstancesRequest(DescribeInstancesRequest 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

getInstanceIds

public String[] getInstanceIds()

Get 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。

Returns:

InstanceIds 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。

Parameters:

InstanceIds - 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。

getFilters

public Filter[] getFilters()

Get 过滤器列表。

instance-name按照【实例名称】进行过滤。 类型：String 必选：否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否 zone按照【可用区】进行过滤。 类型：String 必选：否 instance-state按照【实例状态】进行过滤。 类型：String 必选：否 tag-key按照【标签键】进行过滤。 类型：String 必选：否 tag-value按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。

Returns:

Filters 过滤器列表。

instance-name

按照【实例名称】进行过滤。 类型：String 必选：否

private-ip-address

按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否

public-ip-address

按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否

zone

按照【可用区】进行过滤。 类型：String 必选：否

instance-state

按照【实例状态】进行过滤。 类型：String 必选：否

tag-key

按照【标签键】进行过滤。 类型：String 必选：否

tag-value

按照【标签值】进行过滤。 类型：String 必选：否

tag:tag-key

按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。

setFilters

public void setFilters(Filter[] Filters)

Set 过滤器列表。

instance-name按照【实例名称】进行过滤。 类型：String 必选：否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否 zone按照【可用区】进行过滤。 类型：String 必选：否 instance-state按照【实例状态】进行过滤。 类型：String 必选：否 tag-key按照【标签键】进行过滤。 类型：String 必选：否 tag-value按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。