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

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 Filters `zone` - String - Optional - Filter by the availability zone. `project-id` - Integer - Optional - Filter by the project ID.
String[]	getInstanceIds() Get Query by instance ID(s).
Long	getLimit() Get Number of results returned; default value: 20; maximum: 100.
Long	getOffset() Get Offset; default value: 0.
void	setFilters(Filter[] Filters) Set Filters `zone` - String - Optional - Filter by the availability zone. `project-id` - Integer - Optional - Filter by the project ID.
void	setInstanceIds(String[] InstanceIds) Set Query by instance ID(s).
void	setLimit(Long Limit) Set Number of results returned; default value: 20; maximum: 100.
void	setOffset(Long Offset) Set Offset; default value: 0.
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

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 Query by instance ID(s). For example, instance ID: `ins-xxxxxxxx`. For the specific format, refer to section `Ids.N` of the API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1). You can query up to 100 instances in each request. However, `InstanceIds` and `Filters` cannot be specified at the same time.

Returns:

InstanceIds Query by instance ID(s). For example, instance ID: `ins-xxxxxxxx`. For the specific format, refer to section `Ids.N` of the API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1). You can query up to 100 instances in each request. However, `InstanceIds` and `Filters` cannot be specified at the same time.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Query by instance ID(s). For example, instance ID: `ins-xxxxxxxx`. For the specific format, refer to section `Ids.N` of the API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1). You can query up to 100 instances in each request. However, `InstanceIds` and `Filters` cannot be specified at the same time.

Parameters:

InstanceIds - Query by instance ID(s). For example, instance ID: `ins-xxxxxxxx`. For the specific format, refer to section `Ids.N` of the API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1). You can query up to 100 instances in each request. However, `InstanceIds` and `Filters` cannot be specified at the same time.

getFilters

public Filter[] getFilters()

Get Filters

`zone` - String - Optional - Filter by the availability zone. `project-id` - Integer - Optional - Filter by the project ID. You can query the list of created projects by calling `DescribeProject` or logging in to the [CVM console](https://console.cloud.tencent.com/cvm/index). You can also call `AddProject` to create projects. `host-id` - String - Optional - Filter by the CDH instance ID. Format: `host-xxxxxxxx`. `vpc-id` - String - Optional - Filter by the VPC ID. Format: `vpc-xxxxxxxx`. `subnet-id` - String - Optional - Filter by the subnet ID. Format: `subnet-xxxxxxxx`. `instance-id` - String - Optional - Filter by the instance ID. Format: `ins-xxxxxxxx`. `security-group-id` - String - Optional - Filter by the security group ID. Format: `sg-8jlk3f3r`. `instance-name` - String - Optional - Filter by the instance name. `instance-charge-type` - String - Optional - Filter by the instance billing method. `POSTPAID_BY_HOUR`: pay-as-you-go | `CDHPAID`: You are only billed for [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances, not the CVMs running on the [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances. `private-ip-address` - String - Optional - Filter by the private IP address of the instance's primary ENI. `public-ip-address` - String - Optional - Filter by the public IP address of the instance's primary ENI, including the IP addresses automatically assigned during the instance creation and the EIPs manually associated after the instance creation. `tag-key` - String - Optional - Filter by the tag key. `tag-value` - String - Optional - Filter by the tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair. Replace `tag-key` with the actual tag keys. See example 2. Each request can have up to 10 `Filters` and 5 `Filters.Values`. You cannot specify `InstanceIds` and `Filters` at the same time.

Returns:

Filters Filters

`zone` - String - Optional - Filter by the availability zone.

`project-id` - Integer - Optional - Filter by the project ID. You can query the list of created projects by calling `DescribeProject` or logging in to the [CVM console](https://console.cloud.tencent.com/cvm/index). You can also call `AddProject` to create projects.

`host-id` - String - Optional - Filter by the CDH instance ID. Format: `host-xxxxxxxx`.

`vpc-id` - String - Optional - Filter by the VPC ID. Format: `vpc-xxxxxxxx`.

`subnet-id` - String - Optional - Filter by the subnet ID. Format: `subnet-xxxxxxxx`.

`instance-id` - String - Optional - Filter by the instance ID. Format: `ins-xxxxxxxx`. `security-group-id` - String - Optional - Filter by the security group ID. Format: `sg-8jlk3f3r`. `instance-name` - String - Optional - Filter by the instance name. `instance-charge-type` - String - Optional - Filter by the instance billing method. `POSTPAID_BY_HOUR`: pay-as-you-go | `CDHPAID`: You are only billed for [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances, not the CVMs running on the [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances. `private-ip-address` - String - Optional - Filter by the private IP address of the instance's primary ENI. `public-ip-address` - String - Optional - Filter by the public IP address of the instance's primary ENI, including the IP addresses automatically assigned during the instance creation and the EIPs manually associated after the instance creation.

`tag-key` - String - Optional - Filter by the tag key.

`tag-value` - String - Optional - Filter by the tag value.

`tag:tag-key` - String - Optional - Filter by the tag key-value pair. Replace `tag-key` with the actual tag keys. See example 2.

Each request can have up to 10 `Filters` and 5 `Filters.Values`. You cannot specify `InstanceIds` and `Filters` at the same time.

setFilters

public void setFilters(Filter[] Filters)

Set Filters

`zone` - String - Optional - Filter by the availability zone. `project-id` - Integer - Optional - Filter by the project ID. You can query the list of created projects by calling `DescribeProject` or logging in to the [CVM console](https://console.cloud.tencent.com/cvm/index). You can also call `AddProject` to create projects. `host-id` - String - Optional - Filter by the CDH instance ID. Format: `host-xxxxxxxx`. `vpc-id` - String - Optional - Filter by the VPC ID. Format: `vpc-xxxxxxxx`. `subnet-id` - String - Optional - Filter by the subnet ID. Format: `subnet-xxxxxxxx`. `instance-id` - String - Optional - Filter by the instance ID. Format: `ins-xxxxxxxx`. `security-group-id` - String - Optional - Filter by the security group ID. Format: `sg-8jlk3f3r`. `instance-name` - String - Optional - Filter by the instance name. `instance-charge-type` - String - Optional - Filter by the instance billing method. `POSTPAID_BY_HOUR`: pay-as-you-go | `CDHPAID`: You are only billed for [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances, not the CVMs running on the [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances. `private-ip-address` - String - Optional - Filter by the private IP address of the instance's primary ENI. `public-ip-address` - String - Optional - Filter by the public IP address of the instance's primary ENI, including the IP addresses automatically assigned during the instance creation and the EIPs manually associated after the instance creation. `tag-key` - String - Optional - Filter by the tag key. `tag-value` - String - Optional - Filter by the tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair. Replace `tag-key` with the actual tag keys. See example 2. Each request can have up to 10 `Filters` and 5 `Filters.Values`. You cannot specify `InstanceIds` and `Filters` at the same time.