com.tencentcloudapi.cvm.v20170312.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.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 zone 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。
String[]	getInstanceIds() Get 按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
Long	getLimit() Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
Long	getOffset() Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
void	setFilters(Filter[] Filters) Set zone 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。
void	setInstanceIds(String[] InstanceIds) Set 按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
void	setLimit(Long Limit) Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
void	setOffset(Long Offset) Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
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查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。

Returns:

InstanceIds 按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。

Parameters:

InstanceIds - 按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。

getFilters

public Filter[] getFilters()

Get

zone

按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。

类型：String

必选：否

可选项：可用区列表

project-id

按照【项目ID】进行过滤，可通过调用[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。

类型：Integer

必选：否

host-id

按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。

类型：String

必选：否

dedicated-cluster-id

按照【[CDC](https://cloud.tencent.com/document/product/1346) ID】进行过滤。[CDC](https://cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。

类型：String

必选：否

vpc-id

按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。

类型：String

必选：否

subnet-id

按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。

类型：String

必选：否

instance-id

按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。

类型：String

必选：否

uuid

按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。

类型：String

必选：否

security-group-id

按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。

类型：String

必选：否

instance-name

按照【实例名称】进行过滤。

类型：String

必选：否

instance-charge-type

按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示[CDH](https://cloud.tencent.com/document/product/416)付费，即只对[CDH](https://cloud.tencent.com/document/product/416)计费，不对[CDH](https://cloud.tencent.com/document/product/416)上的实例计费。)

类型：String

必选：否

instance-state

按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)

类型：String

必选：否

private-ip-address

按照【实例主网卡的内网IP】进行过滤。

类型：String

必选：否

public-ip-address

按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。

类型：String

必选：否

ipv6-address

按照【实例的IPv6地址】进行过滤。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。

类型：String

必选：否

creation-start-time

按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

creation-end-time

按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

Returns:

Filters

zone

按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。

类型：String

必选：否

可选项：可用区列表

project-id

按照【项目ID】进行过滤，可通过调用[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。

类型：Integer

必选：否

host-id

按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。

类型：String

必选：否

dedicated-cluster-id

按照【[CDC](https://cloud.tencent.com/document/product/1346) ID】进行过滤。[CDC](https://cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。

类型：String

必选：否

vpc-id

按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。

类型：String

必选：否

subnet-id

按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。

类型：String

必选：否

instance-id

按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。

类型：String

必选：否

uuid

按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。

类型：String

必选：否

security-group-id

按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。

类型：String

必选：否

instance-name

按照【实例名称】进行过滤。

类型：String

必选：否

instance-charge-type

按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示[CDH](https://cloud.tencent.com/document/product/416)付费，即只对[CDH](https://cloud.tencent.com/document/product/416)计费，不对[CDH](https://cloud.tencent.com/document/product/416)上的实例计费。)

类型：String

必选：否

instance-state

按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)

类型：String

必选：否

private-ip-address

按照【实例主网卡的内网IP】进行过滤。

类型：String

必选：否

public-ip-address

按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。

类型：String

必选：否

ipv6-address

按照【实例的IPv6地址】进行过滤。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。

类型：String

必选：否

creation-start-time

按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

creation-end-time

按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

setFilters

public void setFilters(Filter[] Filters)

Set

zone

按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。

类型：String

必选：否

可选项：可用区列表

project-id

按照【项目ID】进行过滤，可通过调用[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。

类型：Integer

必选：否

host-id

按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。

类型：String

必选：否

dedicated-cluster-id

按照【[CDC](https://cloud.tencent.com/document/product/1346) ID】进行过滤。[CDC](https://cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。

类型：String

必选：否

vpc-id

按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。

类型：String

必选：否

subnet-id

按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。

类型：String

必选：否

instance-id

按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。

类型：String

必选：否

uuid

按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。

类型：String

必选：否

security-group-id

按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。

类型：String

必选：否

instance-name

按照【实例名称】进行过滤。

类型：String

必选：否

instance-charge-type

按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示[CDH](https://cloud.tencent.com/document/product/416)付费，即只对[CDH](https://cloud.tencent.com/document/product/416)计费，不对[CDH](https://cloud.tencent.com/document/product/416)上的实例计费。)

类型：String

必选：否

instance-state

按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)

类型：String

必选：否

private-ip-address

按照【实例主网卡的内网IP】进行过滤。

类型：String

必选：否

public-ip-address

按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。

类型：String

必选：否

ipv6-address

按照【实例的IPv6地址】进行过滤。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。

类型：String

必选：否

creation-start-time

按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

creation-end-time

按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。

类型：String

必选：否

每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。