DescribeInstancesRequest (tencentcloud-sdk-java 3.1.68 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.redis.v20180412.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

DescribeInstancesRequest()

Constructors
Constructor and Description
`DescribeInstancesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long[]`	`getAutoRenew()` Get 续费模式：0 - 默认状态（手动续费）；1 - 自动续费；2 - 明确不自动续费
`String`	`getBillingMode()` Get 计费模式：postpaid-按量计费；prepaid-包年包月
`String`	`getEngineName()` Get 引擎信息：Redis-2.8，Redis-4.0，CKV
`String`	`getInstanceId()` Get 实例Id，如：crs-6ubhgouj
`String`	`getInstanceName()` Get 实例名称
`Long`	`getLimit()` Get 实例列表的大小，参数默认值20
`Long`	`getOffset()` Get 偏移量，取Limit整数倍
`String`	`getOrderBy()` Get 枚举范围： projectId,createtime,instancename,type,curDeadline
`Long`	`getOrderType()` Get 1倒序，0顺序，默认倒序
`Long[]`	`getProjectIds()` Get 项目ID 组成的数组，数组下标从0开始
`Long[]`	`getRegionIds()` Get 地域ID，已经弃用，可通过公共参数Region查询对应地域
`String`	`getSearchKey()` Get 查找实例的ID。
`String[]`	`getSearchKeys()` Get 搜索关键词：支持实例Id、实例名称、完整IP
`Long[]`	`getStatus()` Get 实例状态：0-待初始化，1-流程中，2-运行中，-2-已隔离，-3-待删除
`String[]`	`getSubnetIds()` Get 子网ID数组，数组下标从0开始，如：56854
`Long`	`getType()` Get 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
`Long[]`	`getTypeList()` Get 内部参数，用户可忽略
`Long`	`getTypeVersion()` Get 类型版本：1-单机版,2-主从版,3-集群版
`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`	`setEngineName(String EngineName)` Set 引擎信息：Redis-2.8，Redis-4.0，CKV
`void`	`setInstanceId(String InstanceId)` Set 实例Id，如：crs-6ubhgouj
`void`	`setInstanceName(String InstanceName)` Set 实例名称
`void`	`setLimit(Long Limit)` Set 实例列表的大小，参数默认值20
`void`	`setOffset(Long Offset)` Set 偏移量，取Limit整数倍
`void`	`setOrderBy(String OrderBy)` Set 枚举范围： projectId,createtime,instancename,type,curDeadline
`void`	`setOrderType(Long OrderType)` Set 1倒序，0顺序，默认倒序
`void`	`setProjectIds(Long[] ProjectIds)` Set 项目ID 组成的数组，数组下标从0开始
`void`	`setRegionIds(Long[] RegionIds)` Set 地域ID，已经弃用，可通过公共参数Region查询对应地域
`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`	`setType(Long Type)` Set 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
`void`	`setTypeList(Long[] TypeList)` Set 内部参数，用户可忽略
`void`	`setTypeVersion(Long TypeVersion)` Set 类型版本：1-单机版,2-主从版,3-集群版
`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, 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()
```
- Method Detail
  - getLimit
```
public Long getLimit()
```
    Get 实例列表的大小，参数默认值20
    
    Returns:
    
    Limit 实例列表的大小，参数默认值20
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 实例列表的大小，参数默认值20
    
    Parameters:
    
    Limit - 实例列表的大小，参数默认值20
  - getOffset
```
public Long getOffset()
```
    Get 偏移量，取Limit整数倍
    
    Returns:
    
    Offset 偏移量，取Limit整数倍
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 偏移量，取Limit整数倍
    
    Parameters:
    
    Offset - 偏移量，取Limit整数倍
  - getInstanceId
```
public String getInstanceId()
```
    Get 实例Id，如：crs-6ubhgouj
    
    Returns:
    
    InstanceId 实例Id，如：crs-6ubhgouj
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 实例Id，如：crs-6ubhgouj
    
    Parameters:
    
    InstanceId - 实例Id，如：crs-6ubhgouj
  - getOrderBy
```
public String getOrderBy()
```
    Get 枚举范围： projectId,createtime,instancename,type,curDeadline
    
    Returns:
    
    OrderBy 枚举范围： projectId,createtime,instancename,type,curDeadline
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    Set 枚举范围： projectId,createtime,instancename,type,curDeadline
    
    Parameters:
    
    OrderBy - 枚举范围： projectId,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
  - getRegionIds
```
public Long[] getRegionIds()
```
    Get 地域ID，已经弃用，可通过公共参数Region查询对应地域
    
    Returns:
    
    RegionIds 地域ID，已经弃用，可通过公共参数Region查询对应地域
  - setRegionIds
```
public void setRegionIds(Long[] RegionIds)
```
    Set 地域ID，已经弃用，可通过公共参数Region查询对应地域
    
    Parameters:
    
    RegionIds - 地域ID，已经弃用，可通过公共参数Region查询对应地域
  - 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-待删除
  - getTypeVersion
```
public Long getTypeVersion()
```
    Get 类型版本：1-单机版,2-主从版,3-集群版
    
    Returns:
    
    TypeVersion 类型版本：1-单机版,2-主从版,3-集群版
  - setTypeVersion
```
public void setTypeVersion(Long TypeVersion)
```
    Set 类型版本：1-单机版,2-主从版,3-集群版
    
    Parameters:
    
    TypeVersion - 类型版本：1-单机版,2-主从版,3-集群版
  - getEngineName
```
public String getEngineName()
```
    Get 引擎信息：Redis-2.8，Redis-4.0，CKV
    
    Returns:
    
    EngineName 引擎信息：Redis-2.8，Redis-4.0，CKV
  - setEngineName
```
public void setEngineName(String EngineName)
```
    Set 引擎信息：Redis-2.8，Redis-4.0，CKV
    
    Parameters:
    
    EngineName - 引擎信息：Redis-2.8，Redis-4.0，CKV
  - 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 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
    
    Returns:
    
    Type 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
  - setType
```
public void setType(Long Type)
```
    Set 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
    
    Parameters:
    
    Type - 实例类型：1-Redis老集群版；2-Redis 2.8主从版；3-CKV主从版；4-CKV集群版；5-Redis 2.8单机版；6-Redis 4.0主从版；7-Redis 4.0集群版；8 – Redis5.0主从版，9 – Redis5.0集群版，
  - 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 - 内部参数，用户可忽略
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class DescribeInstancesRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

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

getRegionIds

setRegionIds

getStatus

setStatus

getTypeVersion

setTypeVersion

getEngineName

setEngineName

getAutoRenew

setAutoRenew

getBillingMode

setBillingMode

getType

setType

getSearchKeys

setSearchKeys

getTypeList

setTypeList

toMap