public class DescribeInstancesRequest extends AbstractModel
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.
|
Modifier and Type | Method and Description |
---|---|
Long[] |
getAutoRenew()
Get 续费模式。0:默认状态(手动续费)。1:自动续费。2:明确不自动续费。
|
String |
getAzMode()
Get 可用区模式。singleaz:单可用区。multiaz:多可用区。
|
String |
getBillingMode()
Get 计费模式。postpaid:按量计费。prepaid:包年包月。
|
String |
getEngineName()
Get 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。
|
String |
getInstanceId()
Get 实例 ID,如:crs-6ubhgouj。
|
String[] |
getInstanceIds()
Get 批量查询指定的实例 ID,返回结果已 Limit 限制为主。
|
String |
getInstanceName()
Get 实例名称。
|
InstanceTagInfo[] |
getInstanceTags()
Get 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。
|
Long |
getLimit()
Get 每页输出实例的数量,参数默认值20,最大值为1000。
|
String |
getMonitorVersion()
Get 内部参数,用户可忽略。
|
Long |
getOffset()
Get 分页偏移量,取Limit整数倍。
|
String |
getOrderBy()
Get 实例排序依据,枚举值如下所示:projectId:项目ID。createtime:实例创建时间。instancename:实例名称。type:实例类型。curDeadline:实例到期时间。
|
Long |
getOrderType()
Get 实例排序方式,默认为倒序排序。1:倒序。0:顺序。
|
String[] |
getProductVersions()
Get 实例的产品版本。如果该参数不配置或者数组设置为空值,则默认不依据此参数过滤实例。local:本地盘版。cloud:云盘版。cdc:独享集群版。
|
Long[] |
getProjectIds()
Get 项目 ID 组成的数组。
|
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 数组,例如:56854。该参数暂时保留,可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。
|
String[] |
getTagKeys()
Get 根据标签的 Key 筛选资源,该参数不配置或者数组设置为空值,则不根据标签Key进行过滤。
|
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:Redis 5.0 主从版。9:Redis 5.0 集群版。
|
Long[] |
getTypeList()
Get 内部参数,用户可忽略。
|
Long |
getTypeVersion()
Get 实例架构版本。1:单机版。2:主从版。3:集群版。
|
String[] |
getUniqSubnetIds()
Get 私有网络所属子网 ID 数组,如:subnet-fdj24n34j2。
|
String[] |
getUniqVpcIds()
Get 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络,如:vpc-sad23jfdfk。
|
String[] |
getVpcIds()
Get 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留,可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。
|
void |
setAutoRenew(Long[] AutoRenew)
Set 续费模式。0:默认状态(手动续费)。1:自动续费。2:明确不自动续费。
|
void |
setAzMode(String AzMode)
Set 可用区模式。singleaz:单可用区。multiaz:多可用区。
|
void |
setBillingMode(String BillingMode)
Set 计费模式。postpaid:按量计费。prepaid:包年包月。
|
void |
setEngineName(String EngineName)
Set 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。
|
void |
setInstanceId(String InstanceId)
Set 实例 ID,如:crs-6ubhgouj。
|
void |
setInstanceIds(String[] InstanceIds)
Set 批量查询指定的实例 ID,返回结果已 Limit 限制为主。
|
void |
setInstanceName(String InstanceName)
Set 实例名称。
|
void |
setInstanceTags(InstanceTagInfo[] InstanceTags)
Set 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。
|
void |
setLimit(Long Limit)
Set 每页输出实例的数量,参数默认值20,最大值为1000。
|
void |
setMonitorVersion(String MonitorVersion)
Set 内部参数,用户可忽略。
|
void |
setOffset(Long Offset)
Set 分页偏移量,取Limit整数倍。
|
void |
setOrderBy(String OrderBy)
Set 实例排序依据,枚举值如下所示:projectId:项目ID。createtime:实例创建时间。instancename:实例名称。type:实例类型。curDeadline:实例到期时间。
|
void |
setOrderType(Long OrderType)
Set 实例排序方式,默认为倒序排序。1:倒序。0:顺序。
|
void |
setProductVersions(String[] ProductVersions)
Set 实例的产品版本。如果该参数不配置或者数组设置为空值,则默认不依据此参数过滤实例。local:本地盘版。cloud:云盘版。cdc:独享集群版。
|
void |
setProjectIds(Long[] ProjectIds)
Set 项目 ID 组成的数组。
|
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 数组,例如:56854。该参数暂时保留,可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。
|
void |
setTagKeys(String[] TagKeys)
Set 根据标签的 Key 筛选资源,该参数不配置或者数组设置为空值,则不根据标签Key进行过滤。
|
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:Redis 5.0 主从版。9:Redis 5.0 集群版。
|
void |
setTypeList(Long[] TypeList)
Set 内部参数,用户可忽略。
|
void |
setTypeVersion(Long TypeVersion)
Set 实例架构版本。1:单机版。2:主从版。3:集群版。
|
void |
setUniqSubnetIds(String[] UniqSubnetIds)
Set 私有网络所属子网 ID 数组,如:subnet-fdj24n34j2。
|
void |
setUniqVpcIds(String[] UniqVpcIds)
Set 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络,如:vpc-sad23jfdfk。
|
void |
setVpcIds(String[] VpcIds)
Set 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留,可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public DescribeInstancesRequest()
public DescribeInstancesRequest(DescribeInstancesRequest source)
public Long getLimit()
public void setLimit(Long Limit)
Limit
- 每页输出实例的数量,参数默认值20,最大值为1000。public Long getOffset()
public void setOffset(Long Offset)
Offset
- 分页偏移量,取Limit整数倍。public String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId
- 实例 ID,如:crs-6ubhgouj。public String getOrderBy()
public void setOrderBy(String OrderBy)
OrderBy
- 实例排序依据,枚举值如下所示:public Long getOrderType()
public void setOrderType(Long OrderType)
OrderType
- 实例排序方式,默认为倒序排序。public String[] getVpcIds()
public void setVpcIds(String[] VpcIds)
VpcIds
- 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留,可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。public String[] getSubnetIds()
public void setSubnetIds(String[] SubnetIds)
SubnetIds
- 私有网络所属子网 ID 数组,例如:56854。该参数暂时保留,可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。public String getSearchKey()
public void setSearchKey(String SearchKey)
SearchKey
- 设置模糊查询关键字,支持根据实例名称或实例ID模糊查询实例。public Long[] getProjectIds()
public void setProjectIds(Long[] ProjectIds)
ProjectIds
- 项目 ID 组成的数组。public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName
- 实例名称。public String[] getUniqVpcIds()
public void setUniqVpcIds(String[] UniqVpcIds)
UniqVpcIds
- 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络,如:vpc-sad23jfdfk。public String[] getUniqSubnetIds()
public void setUniqSubnetIds(String[] UniqSubnetIds)
UniqSubnetIds
- 私有网络所属子网 ID 数组,如:subnet-fdj24n34j2。public Long[] getRegionIds()
public void setRegionIds(Long[] RegionIds)
RegionIds
- 地域 ID 数组,该参数已经弃用,可通过公共参数Region查询对应地域。public Long[] getStatus()
public void setStatus(Long[] Status)
Status
- 实例状态。public Long getTypeVersion()
public void setTypeVersion(Long TypeVersion)
TypeVersion
- 实例架构版本。public String getEngineName()
public void setEngineName(String EngineName)
EngineName
- 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。public Long[] getAutoRenew()
public void setAutoRenew(Long[] AutoRenew)
AutoRenew
- 续费模式。public String getBillingMode()
public void setBillingMode(String BillingMode)
BillingMode
- 计费模式。public Long getType()
public void setType(Long Type)
Type
- 实例类型。public String[] getSearchKeys()
public void setSearchKeys(String[] SearchKeys)
SearchKeys
- 设置搜索关键字数组,可根据实例ID、实例名称、完整IP地址查询实例。public Long[] getTypeList()
public void setTypeList(Long[] TypeList)
TypeList
- 内部参数,用户可忽略。public String getMonitorVersion()
public void setMonitorVersion(String MonitorVersion)
MonitorVersion
- 内部参数,用户可忽略。public InstanceTagInfo[] getInstanceTags()
public void setInstanceTags(InstanceTagInfo[] InstanceTags)
InstanceTags
- 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。public String[] getTagKeys()
public void setTagKeys(String[] TagKeys)
TagKeys
- 根据标签的 Key 筛选资源,该参数不配置或者数组设置为空值,则不根据标签Key进行过滤。public String[] getProductVersions()
public void setProductVersions(String[] ProductVersions)
ProductVersions
- 实例的产品版本。如果该参数不配置或者数组设置为空值,则默认不依据此参数过滤实例。public String[] getInstanceIds()
public void setInstanceIds(String[] InstanceIds)
InstanceIds
- 批量查询指定的实例 ID,返回结果已 Limit 限制为主。public String getAzMode()
public void setAzMode(String AzMode)
AzMode
- 可用区模式。Copyright © 2023. All rights reserved.