public class CreateInstancesRequest extends AbstractModel
Constructor and Description |
---|
CreateInstancesRequest() |
CreateInstancesRequest(CreateInstancesRequest 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 Auto-renewal flag
- `0`: Manual renewal (default).
|
Long |
getBillingMode()
Get Billing mode.
|
Boolean |
getDryRun()
Get An internal parameter used to indicate whether to check when creating an instance.
|
Long |
getGoodsNum()
Get The number of instances for each purchase.
|
String |
getInstanceName()
Get Instance name, which can contain up to 60 letters, digits, hyphens, and underscores.
|
Long |
getMemSize()
Get Memory capacity in MB, which must be an integer multiple of 1024.
|
Boolean |
getNoAuth()
Get Whether to support password-free access for an instance
- `true`: The instance access is password-free.
|
RedisNodeInfo[] |
getNodeSet()
Get The node information of the instance, including node ID, type, and AZ.
|
String |
getPassword()
Get Instance access password
- When the input parameter `NoAuth` is `true`, it means that the instance access is set to be password-free, and the `Password` field does not need to be configured; otherwise, `Password` is a required parameter.
|
Long |
getPeriod()
Get The purchase duration of an instance
- If `BillingMode` is `1`, that is, when the billing mode is monthly subscription, you need to set this parameter to specify the duration of the purchased instance.
|
String |
getProductVersion()
Get The product edition of the instance
- `local`: Local Disk Edition.
|
Long |
getProjectId()
Get Project ID.
|
String |
getRedisClusterId()
Get Exclusive cluster ID.
|
Long |
getRedisReplicasNum()
Get Quantity of instance replicas
- For Redis Memory Edition 4.0, 5.0, 6.2 (regardless of architecture), the range of replica quantity is [1,5].
|
Long |
getRedisShardNum()
Get Quantity of instance shards
- This parameter is not required for instances of Standard Edition.
|
Boolean |
getReplicasReadonly()
Get Whether to support read-only replicas.
|
ResourceTag[] |
getResourceTags()
Get The tag for an instance
|
String[] |
getSecurityGroupIdList()
Get Array of security group IDs.
|
String |
getSubnetId()
Get VPC subnet ID.
|
String |
getTemplateId()
Get The parameter template ID associated with the instance
- If this parameter is not configured, the system will automatically adapt the corresponding default template based on the selected compatible version and architecture.
|
Long |
getTypeId()
Get Instance type
`2`: Redis 2.8 Memory Edition (Standard Architecture).
|
String |
getVpcId()
Get VPC ID.
|
Long |
getVPort()
Get User-defined network port.
|
Long |
getZoneId()
Get ID of the AZ where the instance resides.
|
String |
getZoneName()
Get Name of the AZ where the instance resides.
|
void |
setAutoRenew(Long AutoRenew)
Set Auto-renewal flag
- `0`: Manual renewal (default).
|
void |
setBillingMode(Long BillingMode)
Set Billing mode.
|
void |
setDryRun(Boolean DryRun)
Set An internal parameter used to indicate whether to check when creating an instance.
|
void |
setGoodsNum(Long GoodsNum)
Set The number of instances for each purchase.
|
void |
setInstanceName(String InstanceName)
Set Instance name, which can contain up to 60 letters, digits, hyphens, and underscores.
|
void |
setMemSize(Long MemSize)
Set Memory capacity in MB, which must be an integer multiple of 1024.
|
void |
setNoAuth(Boolean NoAuth)
Set Whether to support password-free access for an instance
- `true`: The instance access is password-free.
|
void |
setNodeSet(RedisNodeInfo[] NodeSet)
Set The node information of the instance, including node ID, type, and AZ.
|
void |
setPassword(String Password)
Set Instance access password
- When the input parameter `NoAuth` is `true`, it means that the instance access is set to be password-free, and the `Password` field does not need to be configured; otherwise, `Password` is a required parameter.
|
void |
setPeriod(Long Period)
Set The purchase duration of an instance
- If `BillingMode` is `1`, that is, when the billing mode is monthly subscription, you need to set this parameter to specify the duration of the purchased instance.
|
void |
setProductVersion(String ProductVersion)
Set The product edition of the instance
- `local`: Local Disk Edition.
|
void |
setProjectId(Long ProjectId)
Set Project ID.
|
void |
setRedisClusterId(String RedisClusterId)
Set Exclusive cluster ID.
|
void |
setRedisReplicasNum(Long RedisReplicasNum)
Set Quantity of instance replicas
- For Redis Memory Edition 4.0, 5.0, 6.2 (regardless of architecture), the range of replica quantity is [1,5].
|
void |
setRedisShardNum(Long RedisShardNum)
Set Quantity of instance shards
- This parameter is not required for instances of Standard Edition.
|
void |
setReplicasReadonly(Boolean ReplicasReadonly)
Set Whether to support read-only replicas.
|
void |
setResourceTags(ResourceTag[] ResourceTags)
Set The tag for an instance
|
void |
setSecurityGroupIdList(String[] SecurityGroupIdList)
Set Array of security group IDs.
|
void |
setSubnetId(String SubnetId)
Set VPC subnet ID.
|
void |
setTemplateId(String TemplateId)
Set The parameter template ID associated with the instance
- If this parameter is not configured, the system will automatically adapt the corresponding default template based on the selected compatible version and architecture.
|
void |
setTypeId(Long TypeId)
Set Instance type
`2`: Redis 2.8 Memory Edition (Standard Architecture).
|
void |
setVpcId(String VpcId)
Set VPC ID.
|
void |
setVPort(Long VPort)
Set User-defined network port.
|
void |
setZoneId(Long ZoneId)
Set ID of the AZ where the instance resides.
|
void |
setZoneName(String ZoneName)
Set Name of the AZ where the instance resides.
|
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 CreateInstancesRequest()
public CreateInstancesRequest(CreateInstancesRequest source)
public Long getTypeId()
public void setTypeId(Long TypeId)
TypeId
- Instance type
public Long getMemSize()
public void setMemSize(Long MemSize)
MemSize
- Memory capacity in MB, which must be an integer multiple of 1024. For specific specifications, query the sales specifications in all regions through the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.
- When **TypeId** is a standard architecture, **MemSize** is the total memory capacity of the instance;
- When **TypeId** is a cluster architecture, **MemSize** is the single-shard memory capacity.public Long getGoodsNum()
public void setGoodsNum(Long GoodsNum)
GoodsNum
- The number of instances for each purchase. For details, query the sales specifications in all regions through the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.public Long getPeriod()
public void setPeriod(Long Period)
Period
- The purchase duration of an instance
- If `BillingMode` is `1`, that is, when the billing mode is monthly subscription, you need to set this parameter to specify the duration of the purchased instance. Unit: month. Value range: [1,2,3,4,5,6,7,8,9,10,11,12,24,36].
- If `BillingMode` is `0`, that is, when the billing mode is pay-as-you-go, you need to set this parameter to `1`.public Long getBillingMode()
public void setBillingMode(Long BillingMode)
BillingMode
- Billing mode. 0: pay-as-you-gopublic Long getZoneId()
public void setZoneId(Long ZoneId)
ZoneId
- ID of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).public String getPassword()
public void setPassword(String Password)
Password
- Instance access password
- When the input parameter `NoAuth` is `true`, it means that the instance access is set to be password-free, and the `Password` field does not need to be configured; otherwise, `Password` is a required parameter.
- When the instance type `TypeId` is Redis 2.8 Memory Edition (Standard Architecture), Redis 4.0, 5.0, 6.0 (regardless of architecture), the password must contains 8-30 characters in at least two of the following types: lowercase letters, uppercase letters, digits, and symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/), and it cannot start with a slash (/).
- When the instance type **TypeId** is CKV 3.2 Memory Edition (regardless of architecture), the password contains 8-30 letters and digits and excludes other characters.public String getVpcId()
public void setVpcId(String VpcId)
VpcId
- VPC ID. If this parameter is not passed in, the classic network will be selected by default. You can query the specific VPC ID in the [VPC console](https://console.cloud.tencent.com/vpc).public String getSubnetId()
public void setSubnetId(String SubnetId)
SubnetId
- VPC subnet ID. This parameter is not required for the classic network. You can get the specific subnet ID by querying the subnet list in the [VPC console](https://console.cloud.tencent.com/vpc).public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- Project ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis#/), go to the account information menu in the top-right corner, and select **Project Management** to query the project ID.public Long getAutoRenew()
public void setAutoRenew(Long AutoRenew)
AutoRenew
- Auto-renewal flag
- `0`: Manual renewal (default).
- `1`: Auto-renewal.
- `2`: Not auto-renewal (set by user).public String[] getSecurityGroupIdList()
public void setSecurityGroupIdList(String[] SecurityGroupIdList)
SecurityGroupIdList
- Array of security group IDs. Get the security group ID of the instance through the [DescribeInstanceSecurityGroup](https://intl.cloud.tencent.com/document/product/239/34447?from_cn_redirect=1) API.public Long getVPort()
public void setVPort(Long VPort)
VPort
- User-defined network port. Default value: `6379`. Range: [1024,65535].public Long getRedisShardNum()
public void setRedisShardNum(Long RedisShardNum)
RedisShardNum
- Quantity of instance shards
- This parameter is not required for instances of Standard Edition.
- For instances of Cluster Edition, the range of shard quantity is [1, 3, 5, 8, 12, 16, 24, 32, 40, 48, 64, 80, 96, 128].public Long getRedisReplicasNum()
public void setRedisReplicasNum(Long RedisReplicasNum)
RedisReplicasNum
- Quantity of instance replicas
- For Redis Memory Edition 4.0, 5.0, 6.2 (regardless of architecture), the range of replica quantity is [1,5].
- For Redis 2.8 Standard Edition and CKV Standard Edition, the replica quantity is `1`.public Boolean getReplicasReadonly()
public void setReplicasReadonly(Boolean ReplicasReadonly)
ReplicasReadonly
- Whether to support read-only replicas.
- Redis 2.8 Standard Edition and CKV Standard Edition don’t support read-only replicas.
- If read-only replicas are enabled, read/write separation will be automatically enabled for an instance, with write requests routed to the master node and read requests to the replica node.
- To enable read-only replicas, we recommend that you create two or more replicas.public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName
- Instance name, which can contain up to 60 letters, digits, hyphens, and underscores.public Boolean getNoAuth()
public void setNoAuth(Boolean NoAuth)
NoAuth
- Whether to support password-free access for an instance
- `true`: The instance access is password-free.
- `false`: The instance access is password-enabled. Default value: `false`. Only instances in a VPC support the password-free access.public RedisNodeInfo[] getNodeSet()
public void setNodeSet(RedisNodeInfo[] NodeSet)
NodeSet
- The node information of the instance, including node ID, type, and AZ. For more information, see [RedisNodeInfo](https://intl.cloud.tencent.com/document/product/239/20022?from_cn_redirect=1).
Node information of an instance. Currently, information about the node type (master or replica) and node AZ can be passed in. This parameter is not required for instances deployed in a single AZ.public ResourceTag[] getResourceTags()
public void setResourceTags(ResourceTag[] ResourceTags)
ResourceTags
- The tag for an instancepublic String getZoneName()
public void setZoneName(String ZoneName)
ZoneName
- Name of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).public String getTemplateId()
public void setTemplateId(String TemplateId)
TemplateId
- The parameter template ID associated with the instance
- If this parameter is not configured, the system will automatically adapt the corresponding default template based on the selected compatible version and architecture.
- Query the list of parameter templates of an instance to get the template ID through the [DescribeParamTemplates](https://intl.cloud.tencent.com/document/product/239/58750?from_cn_redirect=1) API.public Boolean getDryRun()
public void setDryRun(Boolean DryRun)
DryRun
- An internal parameter used to indicate whether to check when creating an instance.
- `false`: Default value. Send a normal request and create an instance if all the requirements are met.
- `true`: Send a check request and create no instance.public String getProductVersion()
public void setProductVersion(String ProductVersion)
ProductVersion
- The product edition of the instance
- `local`: Local Disk Edition.
- `cloud`: Cloud Disk Edition.
- `cdc`: Dedicated Cluster Edition. Default value: `local`.public String getRedisClusterId()
public void setRedisClusterId(String RedisClusterId)
RedisClusterId
- Exclusive cluster ID. When `ProductVersion` is set to `cdc`, this parameter is required.Copyright © 2023. All rights reserved.