public class DescribeInstancesRequest extends AbstractModel
header, skipSign
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 Renewal pattern.
|
String |
getAzMode()
Get Availability zone mode.
|
String |
getBillingMode()
Get Billing mode.
|
String |
getEngineName()
Get Storage engine information.
|
String |
getInstanceId()
Get ID of a specified instance, such as "crs-xjhsdj****" Log in to the [Redis console](https://console.cloud.tencent.com/redis) and copy the instance ID in the instance list.
|
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 The instance list is sorted according to the following enumeration valid values:
- projectId: By project ID.- createtime: By the creation time of instances.- instancename: By the name of instances.- type: By the type of instances.- curDeadline: By the expiration time of instances.
|
Long |
getOrderType()
Get For instance sorting order, the default is descending order.
|
String[] |
getProductVersions()
Get The product version of the instance.
|
Long[] |
getProjectIds()
Get Array of project IDs
|
Long[] |
getRegionIds()
Get Array of region IDs (disused).
|
String |
getSearchKey()
Get Setting keywords field for fuzzy query, only instance names support fuzzy query.
|
String[] |
getSearchKeys()
Get This parameter is of array type and supports the configuration of instance names, instance IDs, and IP addresses.
|
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 version.
|
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 pattern.
|
void |
setAzMode(String AzMode)
Set Availability zone mode.
|
void |
setBillingMode(String BillingMode)
Set Billing mode.
|
void |
setEngineName(String EngineName)
Set Storage engine information.
|
void |
setInstanceId(String InstanceId)
Set ID of a specified instance, such as "crs-xjhsdj****" Log in to the [Redis console](https://console.cloud.tencent.com/redis) and copy the instance ID in the instance list.
|
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 The instance list is sorted according to the following enumeration valid values:
- projectId: By project ID.- createtime: By the creation time of instances.- instancename: By the name of instances.- type: By the type of instances.- curDeadline: By the expiration time of instances.
|
void |
setOrderType(Long OrderType)
Set For instance sorting order, the default is descending order.
|
void |
setProductVersions(String[] ProductVersions)
Set The product version of the instance.
|
void |
setProjectIds(Long[] ProjectIds)
Set Array of project IDs
|
void |
setRegionIds(Long[] RegionIds)
Set Array of region IDs (disused).
|
void |
setSearchKey(String SearchKey)
Set Setting keywords field for fuzzy query, only instance names support fuzzy query.
|
void |
setSearchKeys(String[] SearchKeys)
Set This parameter is of array type and supports the configuration of instance names, instance IDs, and IP addresses.
|
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 version.
|
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.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public DescribeInstancesRequest()
public DescribeInstancesRequest(DescribeInstancesRequest source)
public Long getLimit()
public void setLimit(Long Limit)
Limit
- Number of instances returned per page. Default value: `20`. Maximum value: `1000`.public Long getOffset()
public void setOffset(Long Offset)
Offset
- Pagination offset, which is an integral multiple of `Limit`. Calculation formula: `offset` = `limit` * (page number - 1).public String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId
- ID of a specified instance, such as "crs-xjhsdj****" Log in to the [Redis console](https://console.cloud.tencent.com/redis) and copy the instance ID in the instance list.public String getOrderBy()
public void setOrderBy(String OrderBy)
OrderBy
- The instance list is sorted according to the following enumeration valid values:
- projectId: By project ID.- createtime: By the creation time of instances.- instancename: By the name of instances.- type: By the type of instances.- curDeadline: By the expiration time of instances.public Long getOrderType()
public void setOrderType(Long OrderType)
OrderType
- For instance sorting order, the default is descending order.
- 1: Descending order.
- 0: Ascending order.public String[] getVpcIds()
public void setVpcIds(String[] VpcIds)
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.public String[] getSubnetIds()
public void setSubnetIds(String[] SubnetIds)
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.public String getSearchKey()
public void setSearchKey(String SearchKey)
SearchKey
- Setting keywords field for fuzzy query, only instance names support fuzzy query.public Long[] getProjectIds()
public void setProjectIds(Long[] ProjectIds)
ProjectIds
- Array of project IDspublic String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName
- Instance namepublic String[] getUniqVpcIds()
public void setUniqVpcIds(String[] UniqVpcIds)
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.public String[] getUniqSubnetIds()
public void setUniqSubnetIds(String[] UniqSubnetIds)
UniqSubnetIds
- Array of VPC subnet IDs such as subnet-fdj24n34j2public Long[] getRegionIds()
public void setRegionIds(Long[] RegionIds)
RegionIds
- Array of region IDs (disused). The corresponding region can be queried through the common parameter `Region`.public Long[] getStatus()
public void setStatus(Long[] Status)
Status
- Instance status.
- 0: To be initialized.
- 1: In process.
- 2: Running.
- -2: Isolated.
- -3: Pending Delete.public Long getTypeVersion()
public void setTypeVersion(Long TypeVersion)
TypeVersion
- Instance architecture version.
- 1: Single-node edition.
- 2: Master-replica edition.- 3: Cluster edition.public String getEngineName()
public void setEngineName(String EngineName)
EngineName
- Storage engine information. Valid values: `Redis-2.8`, `Redis-4.0`, `Redis-5.0`, `Redis-6.0` or `CKV`.public Long[] getAutoRenew()
public void setAutoRenew(Long[] AutoRenew)
AutoRenew
- Renewal pattern.
- 0: Manual renewal.
- 1: Automatic renewal.
- 2: No renewal after expiry.public String getBillingMode()
public void setBillingMode(String BillingMode)
BillingMode
- Billing mode. Only pay-as-you-go billing is supported.public Long getType()
public void setType(Long Type)
Type
- Instance type. Valid values: - `2`: Redis 2.8 Memory Edition (Standard Architecture). - `3`: CKV 3.2 Memory Edition (Standard Architecture). - `4`: CKV 3.2 Memory Edition (Cluster Architecture). - `5`: Redis 2.8 Memory Edition (Standalone). - `6`: Redis 4.0 Memory Edition (Standard Architecture). - `7`: Redis 4.0 Memory Edition (Cluster Architecture). - `8`: Redis 5.0 Memory Edition (Standard Architecture). - `9`: Redis 5.0 Memory Edition (Cluster Architecture). - `15`: Redis 6.2 Memory Edition (Standard Architecture). - `16`: Redis 6.2 Memory Edition (Cluster Architecture).public String[] getSearchKeys()
public void setSearchKeys(String[] SearchKeys)
SearchKeys
- This parameter is of array type and supports the configuration of instance names, instance IDs, and IP addresses. Among these, the instance name is fuzzy matching while the instance ID and IP address are precise matching.
- Each element in the array is used for a union-based matching query.- When both **InstanceId** and **SearchKeys** are configured simultaneously, their intersection will be used for the matching query.public Long[] getTypeList()
public void setTypeList(Long[] TypeList)
TypeList
- Internal parameter, which can be ignored.public String getMonitorVersion()
public void setMonitorVersion(String MonitorVersion)
MonitorVersion
- Internal parameter, which can be ignored.public InstanceTagInfo[] getInstanceTags()
public void setInstanceTags(InstanceTagInfo[] InstanceTags)
InstanceTags
- Resources filter by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.public String[] getTagKeys()
public void setTagKeys(String[] TagKeys)
TagKeys
- Resources filter by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.public String[] getProductVersions()
public void setProductVersions(String[] ProductVersions)
ProductVersions
- The product version of the instance. If this parameter is not configured or the array is set to empty, instances will not be filtered based on this parameter by default.
- local: local Disk Edition.- cdc: Cluster dedicated edition.public String[] getInstanceIds()
public void setInstanceIds(String[] InstanceIds)
InstanceIds
- Batch query of the specified instances ID. The number of results returned is based on `Limit`.public String getAzMode()
public void setAzMode(String AzMode)
AzMode
- Availability zone mode.
- singleaz: Single availability zone.- multiaz: Multiple availability zones.Copyright © 2024. All rights reserved.