com.tencentcloudapi.cvm.v20170312.models.DescribeInstancesRequest 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.cvm.v20170312.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class DescribeInstancesRequest extends AbstractModel{
/**
* 按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
*/
@SerializedName("InstanceIds")
@Expose
private String [] InstanceIds;
/**
* zone
按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。
类型：String
必选：否
可选项：可用区列表
project-id
按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/378/4400)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/378/4398)创建新的项目。项目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
必选：否
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
必选：否
每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
*/
@SerializedName("Filters")
@Expose
private Filter [] Filters;
/**
* 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* Get 按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
* @return InstanceIds 按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
*/
public String [] getInstanceIds() {
return this.InstanceIds;
}
/**
* Set 按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
* @param InstanceIds 按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
*/
public void setInstanceIds(String [] InstanceIds) {
this.InstanceIds = InstanceIds;
}
/**
* Get zone
按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。
类型：String
必选：否
可选项：可用区列表
project-id
按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/378/4400)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/378/4398)创建新的项目。项目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
必选：否
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
必选：否
每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
* @return Filters zone
按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。
类型：String
必选：否
可选项：可用区列表
project-id
按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/378/4400)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/378/4398)创建新的项目。项目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
必选：否
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
必选：否
每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
*/
public Filter [] getFilters() {
return this.Filters;
}
/**
* Set zone
按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。
类型：String
必选：否
可选项：可用区列表
project-id
按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/378/4400)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/378/4398)创建新的项目。项目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
必选：否
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
必选：否
每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
* @param Filters zone
按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。
类型：String
必选：否
可选项：可用区列表
project-id
按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/378/4400)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/378/4398)创建新的项目。项目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
必选：否
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
必选：否
每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
*/
public void setFilters(Filter [] Filters) {
this.Filters = Filters;
}
/**
* Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
* @return Offset 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
public Long getOffset() {
return this.Offset;
}
/**
* Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
* @param Offset 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
* @return Limit 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
* @param Limit 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
public DescribeInstancesRequest() {
}
/**
* 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 DescribeInstancesRequest(DescribeInstancesRequest source) {
if (source.InstanceIds != null) {
this.InstanceIds = new String[source.InstanceIds.length];
for (int i = 0; i < source.InstanceIds.length; i++) {
this.InstanceIds[i] = new String(source.InstanceIds[i]);
}
}
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.Offset != null) {
this.Offset = new Long(source.Offset);
}
if (source.Limit != null) {
this.Limit = new Long(source.Limit);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamArraySimple(map, prefix + "InstanceIds.", this.InstanceIds);
this.setParamArrayObj(map, prefix + "Filters.", this.Filters);
this.setParamSimple(map, prefix + "Offset", this.Offset);
this.setParamSimple(map, prefix + "Limit", this.Limit);
}
}