com.tencentcloudapi.ecm.v20190719.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ecm.v20190719.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 Filter.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getOrderByField() Get Specified sort by field.
Long	getOrderDirection() Get Sorting order.
void	setFilters(Filter[] Filters) Set Filter.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setOrderByField(String OrderByField) Set Specified sort by field.
void	setOrderDirection(Long OrderDirection) Set Sorting order.
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, 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

getFilters

public Filter[] getFilters()

Get Filter. zone String Required: no (Filter) Filter by AZ abbreviation. zone-name String Required: no (Filter) Filter by AZ name. Fuzzy match is supported. module-id String Required: no (Filter) Filter by module ID. instance-id String Required: no (Filter) Filter by instance ID. instance-name String Required: no (Filter) Filter by instance name. Fuzzy match is supported. ip-address String Required: no (Filter) Filter by the instance's private/public IP. instance-uuid string Required: no (Filter) Filter instances by `uuid`. instance-state string Required: no (Filter) Update instances by instance status. internet-service-provider String Required: no (Filter) Filter by the ISP of the instance's public IP. tag-key String Required: no (Filter) Filter by tag key. tag:tag-key String Required: no (Filter) Filter by tag key-value pair. Replace `tag-key` with the specific tag key. instance-family String Required: no (Filter) Filter by model family. module-name String Required: no (Filter) Filter by module name. Fuzzy match is supported. image-id String Required: no (Filter) Filter by instance image ID. vpc-id String Required: no (Filter) Filter by instance VPC ID. subnet-id String Required: no (Filter) Filter by instance subnet ID. If the `Filters` parameter is not specified, the information of all relevant instances will be queried. Each request can contain up to 5 `Filter.Values`.

Returns:

Filters Filter. zone String Required: no (Filter) Filter by AZ abbreviation. zone-name String Required: no (Filter) Filter by AZ name. Fuzzy match is supported. module-id String Required: no (Filter) Filter by module ID. instance-id String Required: no (Filter) Filter by instance ID. instance-name String Required: no (Filter) Filter by instance name. Fuzzy match is supported. ip-address String Required: no (Filter) Filter by the instance's private/public IP. instance-uuid string Required: no (Filter) Filter instances by `uuid`. instance-state string Required: no (Filter) Update instances by instance status. internet-service-provider String Required: no (Filter) Filter by the ISP of the instance's public IP. tag-key String Required: no (Filter) Filter by tag key. tag:tag-key String Required: no (Filter) Filter by tag key-value pair. Replace `tag-key` with the specific tag key. instance-family String Required: no (Filter) Filter by model family. module-name String Required: no (Filter) Filter by module name. Fuzzy match is supported. image-id String Required: no (Filter) Filter by instance image ID. vpc-id String Required: no (Filter) Filter by instance VPC ID. subnet-id String Required: no (Filter) Filter by instance subnet ID. If the `Filters` parameter is not specified, the information of all relevant instances will be queried. Each request can contain up to 5 `Filter.Values`.

setFilters

public void setFilters(Filter[] Filters)

Set Filter. zone String Required: no (Filter) Filter by AZ abbreviation. zone-name String Required: no (Filter) Filter by AZ name. Fuzzy match is supported. module-id String Required: no (Filter) Filter by module ID. instance-id String Required: no (Filter) Filter by instance ID. instance-name String Required: no (Filter) Filter by instance name. Fuzzy match is supported. ip-address String Required: no (Filter) Filter by the instance's private/public IP. instance-uuid string Required: no (Filter) Filter instances by `uuid`. instance-state string Required: no (Filter) Update instances by instance status. internet-service-provider String Required: no (Filter) Filter by the ISP of the instance's public IP. tag-key String Required: no (Filter) Filter by tag key. tag:tag-key String Required: no (Filter) Filter by tag key-value pair. Replace `tag-key` with the specific tag key. instance-family String Required: no (Filter) Filter by model family. module-name String Required: no (Filter) Filter by module name. Fuzzy match is supported. image-id String Required: no (Filter) Filter by instance image ID. vpc-id String Required: no (Filter) Filter by instance VPC ID. subnet-id String Required: no (Filter) Filter by instance subnet ID. If the `Filters` parameter is not specified, the information of all relevant instances will be queried. Each request can contain up to 5 `Filter.Values`.

Parameters:

Filters - Filter. zone String Required: no (Filter) Filter by AZ abbreviation. zone-name String Required: no (Filter) Filter by AZ name. Fuzzy match is supported. module-id String Required: no (Filter) Filter by module ID. instance-id String Required: no (Filter) Filter by instance ID. instance-name String Required: no (Filter) Filter by instance name. Fuzzy match is supported. ip-address String Required: no (Filter) Filter by the instance's private/public IP. instance-uuid string Required: no (Filter) Filter instances by `uuid`. instance-state string Required: no (Filter) Update instances by instance status. internet-service-provider String Required: no (Filter) Filter by the ISP of the instance's public IP. tag-key String Required: no (Filter) Filter by tag key. tag:tag-key String Required: no (Filter) Filter by tag key-value pair. Replace `tag-key` with the specific tag key. instance-family String Required: no (Filter) Filter by model family. module-name String Required: no (Filter) Filter by module name. Fuzzy match is supported. image-id String Required: no (Filter) Filter by instance image ID. vpc-id String Required: no (Filter) Filter by instance VPC ID. subnet-id String Required: no (Filter) Filter by instance subnet ID. If the `Filters` parameter is not specified, the information of all relevant instances will be queried. Each request can contain up to 5 `Filter.Values`.

getOffset

public Long getOffset()

Get Offset. Default value: 0.

Returns:

Offset Offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0.

Parameters:

Offset - Offset. Default value: 0.

getLimit

public Long getLimit()

Get Number of returned results. Default value: 20 (if the number of query results is greater than or equal to 20). Maximum value: 100.

Returns:

Limit Number of returned results. Default value: 20 (if the number of query results is greater than or equal to 20). Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Number of returned results. Default value: 20 (if the number of query results is greater than or equal to 20). Maximum value: 100.

Parameters:

Limit - Number of returned results. Default value: 20 (if the number of query results is greater than or equal to 20). Maximum value: 100.

getOrderByField

public String getOrderByField()

Get Specified sort by field. Currently, valid values are as follows: timestamp: sort by instance creation time. Note: you can sort only by creation time currently. More sort criteria may be supported in the future. If this parameter is not specified, instances will be sorted by creation time by default.

Returns:

OrderByField Specified sort by field. Currently, valid values are as follows: timestamp: sort by instance creation time. Note: you can sort only by creation time currently. More sort criteria may be supported in the future. If this parameter is not specified, instances will be sorted by creation time by default.

setOrderByField

public void setOrderByField(String OrderByField)

Set Specified sort by field. Currently, valid values are as follows: timestamp: sort by instance creation time. Note: you can sort only by creation time currently. More sort criteria may be supported in the future. If this parameter is not specified, instances will be sorted by creation time by default.

Parameters:

OrderByField - Specified sort by field. Currently, valid values are as follows: timestamp: sort by instance creation time. Note: you can sort only by creation time currently. More sort criteria may be supported in the future. If this parameter is not specified, instances will be sorted by creation time by default.

getOrderDirection

public Long getOrderDirection()

Get Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

Returns:

OrderDirection Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

setOrderDirection

public void setOrderDirection(Long OrderDirection)

Set Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

Parameters:

OrderDirection - Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel