DescribeInstancesRequest (tencentcloud-sdk-java 3.1.1303 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.keewidb.v20220308.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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Long[]`	`getAutoRenew()` Get 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
`String`	`getBillingMode()` Get 计费模式。postpaid：按量计费。prepaid：包年包月。
`String`	`getInstanceId()` Get 实例 ID，如：kee-6ubh****。
`String`	`getInstanceName()` Get 实例名称。
`InstanceTagInfo`	`getInstanceTags()` Deprecated.
`Long`	`getLimit()` Get 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
`String`	`getMonitorVersion()` Get 内部参数，用户可忽略。
`Long`	`getOffset()` Get 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
`String`	`getOrderBy()` Get 排序依据。枚举范围如下所示。 projectId：实例按照项目ID排序。createtime：实例按照创建时间排序。instancename：实例按照实例名称排序。type：实例按照类型排序。curDeadline：实例按照到期时间排序。
`Long`	`getOrderType()` Get 排序方式。1：倒序。默认为倒序。0：顺序。
`Long[]`	`getProjectIds()` Get 项目ID 组成的数组，数组下标从0开始
`String`	`getSearchKey()` Get 查找关键字，可输入实例的ID或者实例名称。
`String[]`	`getSearchKeys()` Get 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
`Long[]`	`getStatus()` Get 实例状态。0：待初始化。1：流程中。2：运行中。-2：已隔离。-3：待删除。
`String[]`	`getSubnetIds()` Get 子网ID数组，数组下标从0开始，如：56854
`String[]`	`getTagKeys()` Get 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
`InstanceTagInfo[]`	`getTagList()` Get 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
`Long`	`getType()` Get 实例类型。13：标准版。14：集群版。
`Long[]`	`getTypeList()` Get 内部参数，用户可忽略。
`String[]`	`getUniqSubnetIds()` Get 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
`String[]`	`getUniqVpcIds()` Get 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
`String[]`	`getVpcIds()` Get 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
`void`	`setAutoRenew(Long[] AutoRenew)` Set 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
`void`	`setBillingMode(String BillingMode)` Set 计费模式。postpaid：按量计费。prepaid：包年包月。
`void`	`setInstanceId(String InstanceId)` Set 实例 ID，如：kee-6ubh****。
`void`	`setInstanceName(String InstanceName)` Set 实例名称。
`void`	`setInstanceTags(InstanceTagInfo InstanceTags)` Deprecated.
`void`	`setLimit(Long Limit)` Set 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
`void`	`setMonitorVersion(String MonitorVersion)` Set 内部参数，用户可忽略。
`void`	`setOffset(Long Offset)` Set 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
`void`	`setOrderBy(String OrderBy)` Set 排序依据。枚举范围如下所示。 projectId：实例按照项目ID排序。createtime：实例按照创建时间排序。instancename：实例按照实例名称排序。type：实例按照类型排序。curDeadline：实例按照到期时间排序。
`void`	`setOrderType(Long OrderType)` Set 排序方式。1：倒序。默认为倒序。0：顺序。
`void`	`setProjectIds(Long[] ProjectIds)` Set 项目ID 组成的数组，数组下标从0开始
`void`	`setSearchKey(String SearchKey)` Set 查找关键字，可输入实例的ID或者实例名称。
`void`	`setSearchKeys(String[] SearchKeys)` Set 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
`void`	`setStatus(Long[] Status)` Set 实例状态。0：待初始化。1：流程中。2：运行中。-2：已隔离。-3：待删除。
`void`	`setSubnetIds(String[] SubnetIds)` Set 子网ID数组，数组下标从0开始，如：56854
`void`	`setTagKeys(String[] TagKeys)` Set 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
`void`	`setTagList(InstanceTagInfo[] TagList)` Set 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
`void`	`setType(Long Type)` Set 实例类型。13：标准版。14：集群版。
`void`	`setTypeList(Long[] TypeList)` Set 内部参数，用户可忽略。
`void`	`setUniqSubnetIds(String[] UniqSubnetIds)` Set 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
`void`	`setUniqVpcIds(String[] UniqVpcIds)` Set 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
`void`	`setVpcIds(String[] VpcIds)` Set 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
`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
  - getLimit
```
public Long getLimit()
```
    Get 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
    
    Returns:
    
    Limit 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
    
    Parameters:
    
    Limit - 每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。
  - getOffset
```
public Long getOffset()
```
    Get 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
    
    Returns:
    
    Offset 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
    
    Parameters:
    
    Offset - 分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。
  - getInstanceId
```
public String getInstanceId()
```
    Get 实例 ID，如：kee-6ubh****。
    
    Returns:
    
    InstanceId 实例 ID，如：kee-6ubh****。
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 实例 ID，如：kee-6ubh****。
    
    Parameters:
    
    InstanceId - 实例 ID，如：kee-6ubh****。
  - getOrderBy
```
public String getOrderBy()
```
    Get 排序依据。枚举范围如下所示。
    - projectId：实例按照项目ID排序。
    - createtime：实例按照创建时间排序。
    - instancename：实例按照实例名称排序。
    - type：实例按照类型排序。
    - curDeadline：实例按照到期时间排序。
    Returns:
    OrderBy 排序依据。枚举范围如下所示。
    projectId：实例按照项目ID排序。
    createtime：实例按照创建时间排序。
    instancename：实例按照实例名称排序。
    type：实例按照类型排序。
    curDeadline：实例按照到期时间排序。
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    Set 排序依据。枚举范围如下所示。
    - projectId：实例按照项目ID排序。
    - createtime：实例按照创建时间排序。
    - instancename：实例按照实例名称排序。
    - type：实例按照类型排序。
    - curDeadline：实例按照到期时间排序。
    Parameters:
    OrderBy - 排序依据。枚举范围如下所示。
    projectId：实例按照项目ID排序。
    createtime：实例按照创建时间排序。
    instancename：实例按照实例名称排序。
    type：实例按照类型排序。
    curDeadline：实例按照到期时间排序。
  - getOrderType
```
public Long getOrderType()
```
    Get 排序方式。
    - 1：倒序。默认为倒序。
    - 0：顺序。
    Returns:
    OrderType 排序方式。
    1：倒序。默认为倒序。
    0：顺序。
  - setOrderType
```
public void setOrderType(Long OrderType)
```
    Set 排序方式。
    - 1：倒序。默认为倒序。
    - 0：顺序。
    Parameters:
    OrderType - 排序方式。
    1：倒序。默认为倒序。
    0：顺序。
  - getVpcIds
```
public String[] getVpcIds()
```
    Get 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
    
    Returns:
    
    VpcIds 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
  - setVpcIds
```
public void setVpcIds(String[] VpcIds)
```
    Set 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
    
    Parameters:
    
    VpcIds - 私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525
  - getSubnetIds
```
public String[] getSubnetIds()
```
    Get 子网ID数组，数组下标从0开始，如：56854
    
    Returns:
    
    SubnetIds 子网ID数组，数组下标从0开始，如：56854
  - setSubnetIds
```
public void setSubnetIds(String[] SubnetIds)
```
    Set 子网ID数组，数组下标从0开始，如：56854
    
    Parameters:
    
    SubnetIds - 子网ID数组，数组下标从0开始，如：56854
  - getProjectIds
```
public Long[] getProjectIds()
```
    Get 项目ID 组成的数组，数组下标从0开始
    
    Returns:
    
    ProjectIds 项目ID 组成的数组，数组下标从0开始
  - setProjectIds
```
public void setProjectIds(Long[] ProjectIds)
```
    Set 项目ID 组成的数组，数组下标从0开始
    
    Parameters:
    
    ProjectIds - 项目ID 组成的数组，数组下标从0开始
  - getSearchKey
```
public String getSearchKey()
```
    Get 查找关键字，可输入实例的ID或者实例名称。
    
    Returns:
    
    SearchKey 查找关键字，可输入实例的ID或者实例名称。
  - setSearchKey
```
public void setSearchKey(String SearchKey)
```
    Set 查找关键字，可输入实例的ID或者实例名称。
    
    Parameters:
    
    SearchKey - 查找关键字，可输入实例的ID或者实例名称。
  - getInstanceName
```
public String getInstanceName()
```
    Get 实例名称。
    
    Returns:
    
    InstanceName 实例名称。
  - setInstanceName
```
public void setInstanceName(String InstanceName)
```
    Set 实例名称。
    
    Parameters:
    
    InstanceName - 实例名称。
  - getUniqVpcIds
```
public String[] getUniqVpcIds()
```
    Get 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
    
    Returns:
    
    UniqVpcIds 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
  - setUniqVpcIds
```
public void setUniqVpcIds(String[] UniqVpcIds)
```
    Set 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
    
    Parameters:
    
    UniqVpcIds - 私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk
  - getUniqSubnetIds
```
public String[] getUniqSubnetIds()
```
    Get 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
    
    Returns:
    
    UniqSubnetIds 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
  - setUniqSubnetIds
```
public void setUniqSubnetIds(String[] UniqSubnetIds)
```
    Set 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
    
    Parameters:
    
    UniqSubnetIds - 子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2
  - getStatus
```
public Long[] getStatus()
```
    Get 实例状态。
    - 0：待初始化。
    - 1：流程中。
    - 2：运行中。
    - -2：已隔离。
    - -3：待删除。
    Returns:
    Status 实例状态。
    0：待初始化。
    1：流程中。
    2：运行中。
    -2：已隔离。
    -3：待删除。
  - setStatus
```
public void setStatus(Long[] Status)
```
    Set 实例状态。
    - 0：待初始化。
    - 1：流程中。
    - 2：运行中。
    - -2：已隔离。
    - -3：待删除。
    Parameters:
    Status - 实例状态。
    0：待初始化。
    1：流程中。
    2：运行中。
    -2：已隔离。
    -3：待删除。
  - getAutoRenew
```
public Long[] getAutoRenew()
```
    Get 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
    
    Returns:
    
    AutoRenew 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
  - setAutoRenew
```
public void setAutoRenew(Long[] AutoRenew)
```
    Set 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
    
    Parameters:
    
    AutoRenew - 续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。
  - getBillingMode
```
public String getBillingMode()
```
    Get 计费模式。
    - postpaid：按量计费。
    - prepaid：包年包月。
    Returns:
    BillingMode 计费模式。
    postpaid：按量计费。
    prepaid：包年包月。
  - setBillingMode
```
public void setBillingMode(String BillingMode)
```
    Set 计费模式。
    - postpaid：按量计费。
    - prepaid：包年包月。
    Parameters:
    BillingMode - 计费模式。
    postpaid：按量计费。
    prepaid：包年包月。
  - getType
```
public Long getType()
```
    Get 实例类型。
    - 13：标准版。
    - 14：集群版。
    Returns:
    Type 实例类型。
    13：标准版。
    14：集群版。
  - setType
```
public void setType(Long Type)
```
    Set 实例类型。
    - 13：标准版。
    - 14：集群版。
    Parameters:
    Type - 实例类型。
    13：标准版。
    14：集群版。
  - getSearchKeys
```
public String[] getSearchKeys()
```
    Get 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
    
    Returns:
    
    SearchKeys 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
  - setSearchKeys
```
public void setSearchKeys(String[] SearchKeys)
```
    Set 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
    
    Parameters:
    
    SearchKeys - 搜索关键词：支持实例 ID、实例名称、私有网络IP地址。
  - getTypeList
```
public Long[] getTypeList()
```
    Get 内部参数，用户可忽略。
    
    Returns:
    
    TypeList 内部参数，用户可忽略。
  - setTypeList
```
public void setTypeList(Long[] TypeList)
```
    Set 内部参数，用户可忽略。
    
    Parameters:
    
    TypeList - 内部参数，用户可忽略。
  - getMonitorVersion
```
public String getMonitorVersion()
```
    Get 内部参数，用户可忽略。
    
    Returns:
    
    MonitorVersion 内部参数，用户可忽略。
  - setMonitorVersion
```
public void setMonitorVersion(String MonitorVersion)
```
    Set 内部参数，用户可忽略。
    
    Parameters:
    
    MonitorVersion - 内部参数，用户可忽略。
  - getInstanceTags
```
@Deprecated
public InstanceTagInfo getInstanceTags()
```
    Deprecated.
    
    Get 废弃字段。请使用TagList传参。
    
    Returns:
    
    InstanceTags 废弃字段。请使用TagList传参。
  - setInstanceTags
```
@Deprecated
public void setInstanceTags(InstanceTagInfo InstanceTags)
```
    Deprecated.
    
    Set 废弃字段。请使用TagList传参。
    
    Parameters:
    
    InstanceTags - 废弃字段。请使用TagList传参。
  - getTagKeys
```
public String[] getTagKeys()
```
    Get 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
    
    Returns:
    
    TagKeys 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
  - setTagKeys
```
public void setTagKeys(String[] TagKeys)
```
    Set 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
    
    Parameters:
    
    TagKeys - 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
  - getTagList
```
public InstanceTagInfo[] getTagList()
```
    Get 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
    
    Returns:
    
    TagList 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
  - setTagList
```
public void setTagList(InstanceTagInfo[] TagList)
```
    Set 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
    
    Parameters:
    
    TagList - 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class DescribeInstancesRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeInstancesRequest

DescribeInstancesRequest

Method Detail

getLimit

setLimit

getOffset

setOffset

getInstanceId

setInstanceId

getOrderBy

setOrderBy

getOrderType

setOrderType

getVpcIds

setVpcIds

getSubnetIds

setSubnetIds

getProjectIds

setProjectIds

getSearchKey

setSearchKey

getInstanceName

setInstanceName

getUniqVpcIds

setUniqVpcIds

getUniqSubnetIds

setUniqSubnetIds

getStatus

setStatus

getAutoRenew

setAutoRenew

getBillingMode

setBillingMode

getType

setType

getSearchKeys

setSearchKeys

getTypeList

setTypeList

getMonitorVersion

setMonitorVersion

getInstanceTags

setInstanceTags

getTagKeys

setTagKeys

getTagList

setTagList

toMap