public class CreateDBInstanceRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
CreateDBInstanceRequest() |
CreateDBInstanceRequest(CreateDBInstanceRequest 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 |
---|---|
String[] |
getAlarmPolicyIdList()
Get The array of alarm policy names, such as ["policy-uyoee9wg"].
|
Long[] |
getAlarmPolicyList()
Get Array of alarm policy IDs, which can be obtained through the `OriginId` field in the return value of the `DescribeAlarmPolicy` API of TCOP.
|
Long |
getAutoRenewFlag()
Get Auto-renewal flag.
|
Long |
getAutoSyncFlag()
Get Whether to automatically start disaster recovery synchronization.
|
String |
getBackupZone()
Get Information of replica AZ 2, which is left empty by default.
|
String |
getCageId()
Get Financial cage ID.
|
String |
getClientToken()
Get A string unique in 48 hours, which is supplied by the client to ensure that the request is idempotent.
|
Long |
getCpu()
Get The number of the instance CPU cores.
|
String |
getDeployGroupId()
Get Placement group ID
|
Long |
getDeployMode()
Get Multi-AZ or single-AZ.
|
String |
getDeviceType()
Get Instance isolation type.
|
Boolean |
getDryRun()
Get Whether to check the request without creating any instance.
|
String |
getEngineType()
Get Instance engine type.
|
String |
getEngineVersion()
Get MySQL version.
|
Long |
getGoodsNum()
Get Number of instances.
|
String |
getInstanceName()
Get Instance name.
|
Long |
getInstanceNodes()
Get The number of nodes of the instance.
|
String |
getInstanceRole()
Get Instance typeA.
|
String |
getMasterInstanceId()
Get Instance ID.
|
String |
getMasterRegion()
Get Region information of the source instance, which is required when purchasing a read-only or disaster recovery instance.
|
Long |
getMemory()
Get Instance memory size in MB.
|
ParamInfo[] |
getParamList()
Get List of parameters in the format of ParamList.0.Name=auto_increment&ParamList.0.Value=1.
|
Long |
getParamTemplateId()
Get Parameter template ID
|
String |
getParamTemplateType()
Get Type of the default parameter template.
|
String |
getPassword()
Get The root account password, which can contain 8-64 characters and must contain at least two of the following types of characters: letters, digits, and symbols `_+-&=!@#$%^*()`.
|
Long |
getPeriod()
Get Instance validity period in months.
|
Long |
getPort()
Get Custom port.
|
Long |
getProjectId()
Get Project ID.
|
Long |
getProtectMode()
Get Data replication mode.
|
TagInfo[] |
getResourceTags()
Get Instance tag information
|
RoGroup |
getRoGroup()
Get Read-only instance parameter.
|
String[] |
getSecurityGroup()
Get Security group parameter.
|
String |
getSlaveZone()
Get Information of replica AZ 1, which is the `Zone` value by default.
|
String |
getUniqSubnetId()
Get VPC subnet ID.
|
String |
getUniqVpcId()
Get VPC ID.
|
String[] |
getVips()
Get The list of IPs for sources instances.
|
Long |
getVolume()
Get Instance disk size in GB.
|
String |
getZone()
Get AZ information.
|
void |
setAlarmPolicyIdList(String[] AlarmPolicyIdList)
Set The array of alarm policy names, such as ["policy-uyoee9wg"].
|
void |
setAlarmPolicyList(Long[] AlarmPolicyList)
Set Array of alarm policy IDs, which can be obtained through the `OriginId` field in the return value of the `DescribeAlarmPolicy` API of TCOP.
|
void |
setAutoRenewFlag(Long AutoRenewFlag)
Set Auto-renewal flag.
|
void |
setAutoSyncFlag(Long AutoSyncFlag)
Set Whether to automatically start disaster recovery synchronization.
|
void |
setBackupZone(String BackupZone)
Set Information of replica AZ 2, which is left empty by default.
|
void |
setCageId(String CageId)
Set Financial cage ID.
|
void |
setClientToken(String ClientToken)
Set A string unique in 48 hours, which is supplied by the client to ensure that the request is idempotent.
|
void |
setCpu(Long Cpu)
Set The number of the instance CPU cores.
|
void |
setDeployGroupId(String DeployGroupId)
Set Placement group ID
|
void |
setDeployMode(Long DeployMode)
Set Multi-AZ or single-AZ.
|
void |
setDeviceType(String DeviceType)
Set Instance isolation type.
|
void |
setDryRun(Boolean DryRun)
Set Whether to check the request without creating any instance.
|
void |
setEngineType(String EngineType)
Set Instance engine type.
|
void |
setEngineVersion(String EngineVersion)
Set MySQL version.
|
void |
setGoodsNum(Long GoodsNum)
Set Number of instances.
|
void |
setInstanceName(String InstanceName)
Set Instance name.
|
void |
setInstanceNodes(Long InstanceNodes)
Set The number of nodes of the instance.
|
void |
setInstanceRole(String InstanceRole)
Set Instance typeA.
|
void |
setMasterInstanceId(String MasterInstanceId)
Set Instance ID.
|
void |
setMasterRegion(String MasterRegion)
Set Region information of the source instance, which is required when purchasing a read-only or disaster recovery instance.
|
void |
setMemory(Long Memory)
Set Instance memory size in MB.
|
void |
setParamList(ParamInfo[] ParamList)
Set List of parameters in the format of ParamList.0.Name=auto_increment&ParamList.0.Value=1.
|
void |
setParamTemplateId(Long ParamTemplateId)
Set Parameter template ID
|
void |
setParamTemplateType(String ParamTemplateType)
Set Type of the default parameter template.
|
void |
setPassword(String Password)
Set The root account password, which can contain 8-64 characters and must contain at least two of the following types of characters: letters, digits, and symbols `_+-&=!@#$%^*()`.
|
void |
setPeriod(Long Period)
Set Instance validity period in months.
|
void |
setPort(Long Port)
Set Custom port.
|
void |
setProjectId(Long ProjectId)
Set Project ID.
|
void |
setProtectMode(Long ProtectMode)
Set Data replication mode.
|
void |
setResourceTags(TagInfo[] ResourceTags)
Set Instance tag information
|
void |
setRoGroup(RoGroup RoGroup)
Set Read-only instance parameter.
|
void |
setSecurityGroup(String[] SecurityGroup)
Set Security group parameter.
|
void |
setSlaveZone(String SlaveZone)
Set Information of replica AZ 1, which is the `Zone` value by default.
|
void |
setUniqSubnetId(String UniqSubnetId)
Set VPC subnet ID.
|
void |
setUniqVpcId(String UniqVpcId)
Set VPC ID.
|
void |
setVips(String[] Vips)
Set The list of IPs for sources instances.
|
void |
setVolume(Long Volume)
Set Instance disk size in GB.
|
void |
setZone(String Zone)
Set AZ information.
|
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 CreateDBInstanceRequest()
public CreateDBInstanceRequest(CreateDBInstanceRequest source)
public Long getMemory()
public void setMemory(Long Memory)
Memory
- Instance memory size in MB. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1) API to query the supported memory specifications.public Long getVolume()
public void setVolume(Long Volume)
Volume
- Instance disk size in GB. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1) API to query the supported disk specifications.public Long getPeriod()
public void setPeriod(Long Period)
Period
- Instance validity period in months. Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`.public Long getGoodsNum()
public void setGoodsNum(Long GoodsNum)
GoodsNum
- Number of instances. Value range: 1-100. Default value: `1`.public String getZone()
public void setZone(String Zone)
Zone
- AZ information. The system will automatically select an AZ by default. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1) API to query the supported AZs.public String getUniqVpcId()
public void setUniqVpcId(String UniqVpcId)
UniqVpcId
- VPC ID. If this parameter is not passed in, the basic network will be selected by default. You can use the [DescribeVpcs](https://intl.cloud.tencent.com/document/api/215/15778?from_cn_redirect=1) API to query the VPCs.public String getUniqSubnetId()
public void setUniqSubnetId(String UniqSubnetId)
UniqSubnetId
- VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. You can use the [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API to query the subnet lists.public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- Project ID. If this parameter is left empty, the default project will be used. When you purchase read-only instances and disaster recovery instances, the project ID is the same as that of the source instance by default.public Long getPort()
public void setPort(Long Port)
Port
- Custom port. Value range: 1024-65535.public String getInstanceRole()
public void setInstanceRole(String InstanceRole)
InstanceRole
- Instance typeA. Valid values: `master` (source instance), `dr` (disaster recovery instance), `ro` (read-only instance).public String getMasterInstanceId()
public void setMasterInstanceId(String MasterInstanceId)
MasterInstanceId
- Instance ID. It is required when purchasing a read-only instance, which is the same as the source instance ID. You can use the [DescribeDBInstances](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) API to query the instance ID.public String getEngineVersion()
public void setEngineVersion(String EngineVersion)
EngineVersion
- MySQL version. Valid values: `5.5`, `5.6`, `5.7`, and `8.0`. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1) API to query the supported instance versions.public String getPassword()
public void setPassword(String Password)
Password
- The root account password, which can contain 8-64 characters and must contain at least two of the following types of characters: letters, digits, and symbols `_+-&=!@#$%^*()`. This parameter applies to source instances but not to read-only or disaster recovery instances.public Long getProtectMode()
public void setProtectMode(Long ProtectMode)
ProtectMode
- Data replication mode. Valid values: `0` (async replication), `1` (semi-sync replication), `2` (strong sync replication). Default value: `0`.public Long getDeployMode()
public void setDeployMode(Long DeployMode)
DeployMode
- Multi-AZ or single-AZ. Valid values: `0` (single-AZ), `1` (multi-AZ). Default value: `0`.public String getSlaveZone()
public void setSlaveZone(String SlaveZone)
SlaveZone
- Information of replica AZ 1, which is the `Zone` value by default.public ParamInfo[] getParamList()
public void setParamList(ParamInfo[] ParamList)
ParamList
- List of parameters in the format of ParamList.0.Name=auto_increment&ParamList.0.Value=1. You can use the [DescribeDefaultParams](https://intl.cloud.tencent.com/document/api/236/32662?from_cn_redirect=1) API to query the configurable parameters.public String getBackupZone()
public void setBackupZone(String BackupZone)
BackupZone
- Information of replica AZ 2, which is left empty by default. Specify this parameter when purchasing a source instance in the one-source-two-replica architecture.public Long getAutoRenewFlag()
public void setAutoRenewFlag(Long AutoRenewFlag)
AutoRenewFlag
- Auto-renewal flag. Valid values: `0` (auto-renewal not enabled), `1` (auto-renewal enabled).public String getMasterRegion()
public void setMasterRegion(String MasterRegion)
MasterRegion
- Region information of the source instance, which is required when purchasing a read-only or disaster recovery instance.public String[] getSecurityGroup()
public void setSecurityGroup(String[] SecurityGroup)
SecurityGroup
- Security group parameter. You can use the [DescribeProjectSecurityGroups](https://intl.cloud.tencent.com/document/api/236/15850?from_cn_redirect=1) API to query the security group details of a project.public RoGroup getRoGroup()
public void setRoGroup(RoGroup RoGroup)
RoGroup
- Read-only instance parameter. This parameter must be passed in when purchasing read-only instances.public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName
- Instance name. For multiple instances purchased at one time, they will be distinguished by the name suffix number, such as instnaceName=db and goodsNum=3, and their instance names are db1, db2, and db3, respectively.public TagInfo[] getResourceTags()
public void setResourceTags(TagInfo[] ResourceTags)
ResourceTags
- Instance tag informationpublic String getDeployGroupId()
public void setDeployGroupId(String DeployGroupId)
DeployGroupId
- Placement group IDpublic String getClientToken()
public void setClientToken(String ClientToken)
ClientToken
- A string unique in 48 hours, which is supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.public String getDeviceType()
public void setDeviceType(String DeviceType)
DeviceType
- Instance isolation type. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). Default value: `UNIVERSAL`.public Long getParamTemplateId()
public void setParamTemplateId(Long ParamTemplateId)
ParamTemplateId
- Parameter template IDpublic Long[] getAlarmPolicyList()
public void setAlarmPolicyList(Long[] AlarmPolicyList)
AlarmPolicyList
- Array of alarm policy IDs, which can be obtained through the `OriginId` field in the return value of the `DescribeAlarmPolicy` API of TCOP.public Long getInstanceNodes()
public void setInstanceNodes(Long InstanceNodes)
InstanceNodes
- The number of nodes of the instance. To purchase a read-only instance or a basic instance, set this parameter to `1` or leave it empty. To purchase a three-node instance, set this parameter to `3` or specify the `BackupZone` parameter. If the instance to be purchased is a source instance and both `BackupZone` and this parameter are left empty, the value `2` will be used, which indicates the source instance will have two nodes.public Long getCpu()
public void setCpu(Long Cpu)
Cpu
- The number of the instance CPU cores. If this parameter is left empty, it will be subject to the `Memory` value.public Long getAutoSyncFlag()
public void setAutoSyncFlag(Long AutoSyncFlag)
AutoSyncFlag
- Whether to automatically start disaster recovery synchronization. This parameter takes effect only for disaster recovery instances. Valid values: `0` (no), `1` (yes). Default value: `0`.public String getCageId()
public void setCageId(String CageId)
CageId
- Financial cage ID.public String getParamTemplateType()
public void setParamTemplateType(String ParamTemplateType)
ParamTemplateType
- Type of the default parameter template. Valid values: `HIGH_STABILITY` (high-stability template), `HIGH_PERFORMANCE` (high-performance template).public String[] getAlarmPolicyIdList()
public void setAlarmPolicyIdList(String[] AlarmPolicyIdList)
AlarmPolicyIdList
- The array of alarm policy names, such as ["policy-uyoee9wg"]. If the `AlarmPolicyList` parameter is specified, this parameter is invalid.public Boolean getDryRun()
public void setDryRun(Boolean DryRun)
DryRun
- Whether to check the request without creating any instance. Valid values: `true`, `false` (default). After being submitted, the request will be checked to see if it is in correct format and has all required parameters with valid values. An error code is returned if the check failed, and `RequestId` is returned if the check succeeded. After a successful check, no instance will be created if this parameter is set to `true`, whereas an instance will be created and if it is set to `false`.public String getEngineType()
public void setEngineType(String EngineType)
EngineType
- Instance engine type. Valid values: `InnoDB` (default), `RocksDB`.public String[] getVips()
public void setVips(String[] Vips)
Vips
- The list of IPs for sources instances. Only one IP address can be assigned to a single source instance. If all IPs are used up, the system will automatically assign IPs to the remaining source instances that do not have one.Copyright © 2024. All rights reserved.