com.tencentcloudapi.redis.v20180412.models

Class DescribeInstancesRequest

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()
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
Long[]	getAutoRenew() Get Renewal mode.
String	getAzMode() Get AZ deployment mode.
String	getBillingMode() Get Billing mode.
String	getEngineName() Get Storage engine information.
String	getInstanceId() Get Instance ID, such as crs-6ubhgouj.
String[]	getInstanceIds() Get Batch query of the specified instances ID.
String	getInstanceName() Get Instance name
InstanceTagInfo[]	getInstanceTags() Get Resources filter by tag key and value.
Long	getLimit() Get Number of instances returned per page.
String	getMonitorVersion() Get Internal parameter, which can be ignored.
Long	getOffset() Get Pagination offset, which is an integral multiple of `Limit`.
String	getOrderBy() Get Instance sorting criteria.
Long	getOrderType() Get Instance sorting order.
String[]	getProductVersions() Get Instance product version.
Long[]	getProjectIds() Get Array of project IDs
Long[]	getRegionIds() Get Array of region IDs (disused).
String	getSearchKey() Get Keywords for fuzzy query.
String[]	getSearchKeys() Get Array of the search keywords, which can query the instance by its ID, name, IP address.
Long[]	getStatus() Get Instance status.
String[]	getSubnetIds() Get Array of VPC subnet IDs such as 56854.
String[]	getTagKeys() Get Resources filter by tag key.
Long	getType() Get Instance type.
Long[]	getTypeList() Get Internal parameter, which can be ignored.
Long	getTypeVersion() Get Instance architecture.
String[]	getUniqSubnetIds() Get Array of VPC subnet IDs such as subnet-fdj24n34j2
String[]	getUniqVpcIds() Get Array of VPC IDs such as vpc-sad23jfdfk.
String[]	getVpcIds() Get Array of VPC IDs such as 47525.
void	setAutoRenew(Long[] AutoRenew) Set Renewal mode.
void	setAzMode(String AzMode) Set AZ deployment mode.
void	setBillingMode(String BillingMode) Set Billing mode.
void	setEngineName(String EngineName) Set Storage engine information.
void	setInstanceId(String InstanceId) Set Instance ID, such as crs-6ubhgouj.
void	setInstanceIds(String[] InstanceIds) Set Batch query of the specified instances ID.
void	setInstanceName(String InstanceName) Set Instance name
void	setInstanceTags(InstanceTagInfo[] InstanceTags) Set Resources filter by tag key and value.
void	setLimit(Long Limit) Set Number of instances returned per page.
void	setMonitorVersion(String MonitorVersion) Set Internal parameter, which can be ignored.
void	setOffset(Long Offset) Set Pagination offset, which is an integral multiple of `Limit`.
void	setOrderBy(String OrderBy) Set Instance sorting criteria.
void	setOrderType(Long OrderType) Set Instance sorting order.
void	setProductVersions(String[] ProductVersions) Set Instance product version.
void	setProjectIds(Long[] ProjectIds) Set Array of project IDs
void	setRegionIds(Long[] RegionIds) Set Array of region IDs (disused).
void	setSearchKey(String SearchKey) Set Keywords for fuzzy query.
void	setSearchKeys(String[] SearchKeys) Set Array of the search keywords, which can query the instance by its ID, name, IP address.
void	setStatus(Long[] Status) Set Instance status.
void	setSubnetIds(String[] SubnetIds) Set Array of VPC subnet IDs such as 56854.
void	setTagKeys(String[] TagKeys) Set Resources filter by tag key.
void	setType(Long Type) Set Instance type.
void	setTypeList(Long[] TypeList) Set Internal parameter, which can be ignored.
void	setTypeVersion(Long TypeVersion) Set Instance architecture.
void	setUniqSubnetIds(String[] UniqSubnetIds) Set Array of VPC subnet IDs such as subnet-fdj24n34j2
void	setUniqVpcIds(String[] UniqVpcIds) Set Array of VPC IDs such as vpc-sad23jfdfk.
void	setVpcIds(String[] VpcIds) Set Array of VPC IDs such as 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()

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 Number of instances returned per page. Default value: `20`. Maximum value: `1000`.

Returns:

Limit Number of instances returned per page. Default value: `20`. Maximum value: `1000`.

setLimit

public void setLimit(Long Limit)

Set Number of instances returned per page. Default value: `20`. Maximum value: `1000`.

Parameters:

Limit - Number of instances returned per page. Default value: `20`. Maximum value: `1000`.

getOffset

public Long getOffset()

Get Pagination offset, which is an integral multiple of `Limit`.

Returns:

Offset Pagination offset, which is an integral multiple of `Limit`.

setOffset

public void setOffset(Long Offset)

Set Pagination offset, which is an integral multiple of `Limit`.

Parameters:

Offset - Pagination offset, which is an integral multiple of `Limit`.

getInstanceId

public String getInstanceId()

Get Instance ID, such as crs-6ubhgouj.

Returns:

InstanceId Instance ID, such as crs-6ubhgouj.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID, such as crs-6ubhgouj.

Parameters:

InstanceId - Instance ID, such as crs-6ubhgouj.

getOrderBy

public String getOrderBy()

Get Instance sorting criteria. The enumerated values are as listed below:

• projectId: Project ID.
• createtime: Instance creation time.
• instancename: Instance name.
• type: Instance type.
• curDeadline: Instance expiration time.

Returns:

OrderBy Instance sorting criteria. The enumerated values are as listed below:

• projectId: Project ID.
• createtime: Instance creation time.
• instancename: Instance name.
• type: Instance type.
• curDeadline: Instance expiration time.

setOrderBy

public void setOrderBy(String OrderBy)

Set Instance sorting criteria. The enumerated values are as listed below:

• projectId: Project ID.
• createtime: Instance creation time.
• instancename: Instance name.
• type: Instance type.
• curDeadline: Instance expiration time.

Parameters:

OrderBy - Instance sorting criteria. The enumerated values are as listed below:

• projectId: Project ID.
• createtime: Instance creation time.
• instancename: Instance name.
• type: Instance type.
• curDeadline: Instance expiration time.

getOrderType

public Long getOrderType()

Get Instance sorting order.

• `1`: Descending.
• `0`: Ascending. Default value: `1`.

Returns:

OrderType Instance sorting order.

• `1`: Descending.
• `0`: Ascending. Default value: `1`.

setOrderType

public void setOrderType(Long OrderType)

Set Instance sorting order.

• `1`: Descending.
• `0`: Ascending. Default value: `1`.

Parameters:

OrderType - Instance sorting order.

• `1`: Descending.
• `0`: Ascending. Default value: `1`.

getVpcIds

public String[] getVpcIds()

Get Array of VPC IDs such as 47525. If this parameter is not passed in or the array is empty, the classic network will be selected by default. This parameter is retained and can be ignored. It is set based on `UniqVpcIds` parameter format.

Returns:

VpcIds Array of VPC IDs such as 47525. If this parameter is not passed in or the array is empty, the classic network will be selected by default. This parameter is retained and can be ignored. It is set based on `UniqVpcIds` parameter format.

setVpcIds

public void setVpcIds(String[] VpcIds)

Set Array of VPC IDs such as 47525. If this parameter is not passed in or the array is empty, the classic network will be selected by default. This parameter is retained and can be ignored. It is set based on `UniqVpcIds` parameter format.

Parameters:

VpcIds - Array of VPC IDs such as 47525. If this parameter is not passed in or the array is empty, the classic network will be selected by default. This parameter is retained and can be ignored. It is set based on `UniqVpcIds` parameter format.

getSubnetIds

public String[] getSubnetIds()

Get Array of VPC subnet IDs such as 56854. This parameter is retained and can be ignored. It is set based on `UniqSubnetIds` parameter format.

Returns:

SubnetIds Array of VPC subnet IDs such as 56854. This parameter is retained and can be ignored. It is set based on `UniqSubnetIds` parameter format.

setSubnetIds

public void setSubnetIds(String[] SubnetIds)

Set Array of VPC subnet IDs such as 56854. This parameter is retained and can be ignored. It is set based on `UniqSubnetIds` parameter format.

Parameters:

SubnetIds - Array of VPC subnet IDs such as 56854. This parameter is retained and can be ignored. It is set based on `UniqSubnetIds` parameter format.

getSearchKey

public String getSearchKey()

Get Keywords for fuzzy query. which can be used to fuzzy query an instance by its ID or name.

Returns:

SearchKey Keywords for fuzzy query. which can be used to fuzzy query an instance by its ID or name.

setSearchKey

public void setSearchKey(String SearchKey)

Set Keywords for fuzzy query. which can be used to fuzzy query an instance by its ID or name.

Parameters:

SearchKey - Keywords for fuzzy query. which can be used to fuzzy query an instance by its ID or name.

getProjectIds

public Long[] getProjectIds()

Get Array of project IDs

Returns:

ProjectIds Array of project IDs

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set Array of project IDs

Parameters:

ProjectIds - Array of project IDs

getInstanceName

public String getInstanceName()

Get Instance name

Returns:

InstanceName Instance name

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name

Parameters:

InstanceName - Instance name

getUniqVpcIds

public String[] getUniqVpcIds()

Get Array of VPC IDs such as vpc-sad23jfdfk. If this parameter is not passed in or or the array is empty, the classic network will be selected by default.

Returns:

UniqVpcIds Array of VPC IDs such as vpc-sad23jfdfk. If this parameter is not passed in or or the array is empty, the classic network will be selected by default.

setUniqVpcIds

public void setUniqVpcIds(String[] UniqVpcIds)

Set Array of VPC IDs such as vpc-sad23jfdfk. If this parameter is not passed in or or the array is empty, the classic network will be selected by default.

Parameters:

UniqVpcIds - Array of VPC IDs such as vpc-sad23jfdfk. If this parameter is not passed in or or the array is empty, the classic network will be selected by default.

getUniqSubnetIds

public String[] getUniqSubnetIds()

Get Array of VPC subnet IDs such as subnet-fdj24n34j2

Returns:

UniqSubnetIds Array of VPC subnet IDs such as subnet-fdj24n34j2

setUniqSubnetIds

public void setUniqSubnetIds(String[] UniqSubnetIds)

Set Array of VPC subnet IDs such as subnet-fdj24n34j2

Parameters:

UniqSubnetIds - Array of VPC subnet IDs such as subnet-fdj24n34j2

getRegionIds

public Long[] getRegionIds()

Get Array of region IDs (disused). The corresponding region can be queried through the common parameter `Region`.

Returns:

RegionIds Array of region IDs (disused). The corresponding region can be queried through the common parameter `Region`.

setRegionIds

public void setRegionIds(Long[] RegionIds)

Set Array of region IDs (disused). The corresponding region can be queried through the common parameter `Region`.

Parameters:

RegionIds - Array of region IDs (disused). The corresponding region can be queried through the common parameter `Region`.

getStatus

public Long[] getStatus()

Get Instance status.

• `0`: Uninitialized.
• `1`: In the process.
• `2`: Running.
• `-2`: Isolated.
• `-3`: To be deleted.

Returns:

Status Instance status.

• `0`: Uninitialized.
• `1`: In the process.
• `2`: Running.
• `-2`: Isolated.
• `-3`: To be deleted.

setStatus

public void setStatus(Long[] Status)

Set Instance status.

• `0`: Uninitialized.
• `1`: In the process.
• `2`: Running.
• `-2`: Isolated.
• `-3`: To be deleted.

Parameters:

Status - Instance status.

• `0`: Uninitialized.
• `1`: In the process.
• `2`: Running.
• `-2`: Isolated.
• `-3`: To be deleted.

getTypeVersion

public Long getTypeVersion()

Get Instance architecture.

• `1`: Standalone edition.
• `2`: Master-replica edition.
• `3`: Cluster edition.

Returns:

TypeVersion Instance architecture.

• `1`: Standalone edition.
• `2`: Master-replica edition.
• `3`: Cluster edition.

setTypeVersion

public void setTypeVersion(Long TypeVersion)

Set Instance architecture.

• `1`: Standalone edition.
• `2`: Master-replica edition.
• `3`: Cluster edition.

Parameters:

TypeVersion - Instance architecture.

• `1`: Standalone edition.
• `2`: Master-replica edition.
• `3`: Cluster edition.

getEngineName

public String getEngineName()

Get Storage engine information. Valid values: `Redis-2.8`, `Redis-4.0`, `Redis-5.0`, `Redis-6.0` or `CKV`.

Returns:

EngineName Storage engine information. Valid values: `Redis-2.8`, `Redis-4.0`, `Redis-5.0`, `Redis-6.0` or `CKV`.

setEngineName

public void setEngineName(String EngineName)

Set Storage engine information. Valid values: `Redis-2.8`, `Redis-4.0`, `Redis-5.0`, `Redis-6.0` or `CKV`.

Parameters:

EngineName - Storage engine information. Valid values: `Redis-2.8`, `Redis-4.0`, `Redis-5.0`, `Redis-6.0` or `CKV`.

getAutoRenew

public Long[] getAutoRenew()

Get Renewal mode.

• `0`: Manual renewal (default).
• `1`: Auto-renewal.
• `2`: No auto-renewal (set by user)

Returns:

AutoRenew Renewal mode.

• `0`: Manual renewal (default).
• `1`: Auto-renewal.
• `2`: No auto-renewal (set by user)

setAutoRenew

public void setAutoRenew(Long[] AutoRenew)

Set Renewal mode.

• `0`: Manual renewal (default).
• `1`: Auto-renewal.
• `2`: No auto-renewal (set by user)

Parameters:

AutoRenew - Renewal mode.

• `0`: Manual renewal (default).
• `1`: Auto-renewal.
• `2`: No auto-renewal (set by user)

getBillingMode

public String getBillingMode()

Get Billing mode. Only pay-as-you-go billing is supported.

Returns:

BillingMode Billing mode. Only pay-as-you-go billing is supported.

setBillingMode

public void setBillingMode(String BillingMode)

Set Billing mode. Only pay-as-you-go billing is supported.

Parameters:

BillingMode - Billing mode. Only pay-as-you-go billing is supported.

getType

public Long getType()

Get Instance type.

• `1`: Legacy Redis cluster edition.
• `2`: Redis 2.8 master-replica edition.
• `3`: CKV master-replica edition.
• `4`: CKV cluster edition.
• `5`: Redis 2.8 standalone edition.
• `6`: Redis 4.0 master-replica edition.
• `7`: Redis 4.0 cluster edition.
• 8: Redis 5.0 master-replica edition.
• `9`: Redis 5.0 cluster edition.

Returns:

Type Instance type.

• `1`: Legacy Redis cluster edition.
• `2`: Redis 2.8 master-replica edition.
• `3`: CKV master-replica edition.
• `4`: CKV cluster edition.
• `5`: Redis 2.8 standalone edition.
• `6`: Redis 4.0 master-replica edition.
• `7`: Redis 4.0 cluster edition.
• 8: Redis 5.0 master-replica edition.
• `9`: Redis 5.0 cluster edition.

setType

public void setType(Long Type)

Set Instance type.

• `1`: Legacy Redis cluster edition.
• `2`: Redis 2.8 master-replica edition.
• `3`: CKV master-replica edition.
• `4`: CKV cluster edition.
• `5`: Redis 2.8 standalone edition.
• `6`: Redis 4.0 master-replica edition.
• `7`: Redis 4.0 cluster edition.
• 8: Redis 5.0 master-replica edition.
• `9`: Redis 5.0 cluster edition.

Parameters:

Type - Instance type.

• `1`: Legacy Redis cluster edition.
• `2`: Redis 2.8 master-replica edition.
• `3`: CKV master-replica edition.
• `4`: CKV cluster edition.
• `5`: Redis 2.8 standalone edition.
• `6`: Redis 4.0 master-replica edition.
• `7`: Redis 4.0 cluster edition.
• 8: Redis 5.0 master-replica edition.
• `9`: Redis 5.0 cluster edition.

getSearchKeys

public String[] getSearchKeys()

Get Array of the search keywords, which can query the instance by its ID, name, IP address.

Returns:

SearchKeys Array of the search keywords, which can query the instance by its ID, name, IP address.

setSearchKeys

public void setSearchKeys(String[] SearchKeys)

Set Array of the search keywords, which can query the instance by its ID, name, IP address.

Parameters:

SearchKeys - Array of the search keywords, which can query the instance by its ID, name, IP address.

getTypeList

public Long[] getTypeList()

Get Internal parameter, which can be ignored.

Returns:

TypeList Internal parameter, which can be ignored.

setTypeList

public void setTypeList(Long[] TypeList)

Set Internal parameter, which can be ignored.

Parameters:

TypeList - Internal parameter, which can be ignored.

getMonitorVersion

public String getMonitorVersion()

Get Internal parameter, which can be ignored.

Returns:

MonitorVersion Internal parameter, which can be ignored.

setMonitorVersion

public void setMonitorVersion(String MonitorVersion)

Set Internal parameter, which can be ignored.

Parameters:

MonitorVersion - Internal parameter, which can be ignored.

getInstanceTags

public InstanceTagInfo[] getInstanceTags()

Get Resources filter by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

Returns:

InstanceTags Resources filter by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

setInstanceTags

public void setInstanceTags(InstanceTagInfo[] InstanceTags)

Set Resources filter by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

Parameters:

InstanceTags - Resources filter by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

getTagKeys

public String[] getTagKeys()

Get Resources filter by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

Returns:

TagKeys Resources filter by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

setTagKeys

public void setTagKeys(String[] TagKeys)

Set Resources filter by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

Parameters:

TagKeys - Resources filter by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

getProductVersions

public String[] getProductVersions()

Get Instance product version. If this parameter is not passed in or the array is empty, the instances will not be filtered based this parameter by default.

• `local`: local disk edition.
• `cloud`: Cloud disk edition.
• `cdc`: Dedicated cluster edition.

Returns:

ProductVersions Instance product version. If this parameter is not passed in or the array is empty, the instances will not be filtered based this parameter by default.

• `local`: local disk edition.
• `cloud`: Cloud disk edition.
• `cdc`: Dedicated cluster edition.

setProductVersions

public void setProductVersions(String[] ProductVersions)

Set Instance product version. If this parameter is not passed in or the array is empty, the instances will not be filtered based this parameter by default.

• `local`: local disk edition.
• `cloud`: Cloud disk edition.
• `cdc`: Dedicated cluster edition.

Parameters:

ProductVersions - Instance product version. If this parameter is not passed in or the array is empty, the instances will not be filtered based this parameter by default.

• `local`: local disk edition.
• `cloud`: Cloud disk edition.
• `cdc`: Dedicated cluster edition.

getInstanceIds

public String[] getInstanceIds()

Get Batch query of the specified instances ID. The number of results returned is based on `Limit`.

Returns:

InstanceIds Batch query of the specified instances ID. The number of results returned is based on `Limit`.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Batch query of the specified instances ID. The number of results returned is based on `Limit`.

Parameters:

InstanceIds - Batch query of the specified instances ID. The number of results returned is based on `Limit`.

getAzMode

public String getAzMode()

Get AZ deployment mode.

• `singleaz`: Single-AZ.
• `1`: Multi-AZ.

Returns:

AzMode AZ deployment mode.

• `singleaz`: Single-AZ.
• `1`: Multi-AZ.

setAzMode

public void setAzMode(String AzMode)

Set AZ deployment mode.

• `singleaz`: Single-AZ.
• `1`: Multi-AZ.

Parameters:

AzMode - AZ deployment mode.

• `singleaz`: Single-AZ.
• `1`: Multi-AZ.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel