public class CreateInstancesRequest extends AbstractModel
header, skipSign| 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 |
getActivityId()
Get Campaign ID
|
String |
getAdminName()
Get Username of the instance root account, which has the following rules:
It must contain 1–16 letters , digits, or underscores
It can't be `postgres`.
|
String |
getAdminPassword()
Get Password of the instance root account, which must contain 8-32 characters (above 12 characters preferably).
|
Long |
getAutoRenewFlag()
Get Auto-renewal flag.
|
Long |
getAutoVoucher()
Get Whether to use vouchers automatically.
|
String |
getCharset()
Get Instance character set.
|
String |
getDBEngine()
Get Database engines.
|
String |
getDBEngineConfig()
Get Configuration information of database engine in the following format:
{"$key1":"$value1", "$key2":"$value2"}
Valid values:
mssql_compatible engine:
`migrationMode`: Database mode.
|
String |
getDBKernelVersion()
Get PostgreSQL kernel version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
String |
getDBMajorVersion()
Get The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
DBNode[] |
getDBNodeSet()
Get Deployment information of the instance node, which will display the information of each AZ when the instance node is deployed across multiple AZs.
|
String |
getDBVersion()
Get Number of the major PostgreSQL community version and minor version, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
String |
getInstanceChargeType()
Get Instance billing mode.
|
Long |
getInstanceCount()
Get The number of instances to be purchased at a time.
|
String |
getKMSKeyId()
Get KeyId of custom key, which is required if you select custom key encryption.
|
String |
getKMSRegion()
Get The region where the KMS service is enabled.
|
String |
getName()
Get Instance name, which can contain up to 60 letters, digits, hyphens, and symbols (_-).
|
Long |
getNeedSupportIpv6()
Get Whether IPv6 is supported.
|
Long |
getNeedSupportTDE()
Get Whether to support TDE.
|
Long |
getPeriod()
Get Validity period in months.
|
Long |
getProjectId()
Get Project ID
|
String[] |
getSecurityGroupIds()
Get Security group of the instance, which can be obtained from the `sgld` field in the return value of the [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808?from_cn_redirect=1) API.
|
String |
getSpecCode()
Get Purchasable code, which can be obtained from the `SpecCode` field in the return value of the [DescribeClasses](https://intl.cloud.tencent.com/document/api/409/89019?from_cn_redirect=1) API.
|
Long |
getStorage()
Get Instance storage capacity in GB
|
String |
getSubnetId()
Get VPC subnet ID in the format of `subnet-xxxxxxxx`, u200cwhich can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
|
String |
getSyncMode()
Get Primary-standby sync mode.
|
Tag[] |
getTagList()
Get The information of tags to be bound with the instance, which is left empty by default.
|
String[] |
getVoucherIds()
Get Voucher ID list.
|
String |
getVpcId()
Get VPC ID in the format of `vpc-xxxxxxx`.
|
String |
getZone()
Get Primary AZ of the instance in the format of `ap-guangzhou-3`.
|
void |
setActivityId(Long ActivityId)
Set Campaign ID
|
void |
setAdminName(String AdminName)
Set Username of the instance root account, which has the following rules:
It must contain 1–16 letters , digits, or underscores
It can't be `postgres`.
|
void |
setAdminPassword(String AdminPassword)
Set Password of the instance root account, which must contain 8-32 characters (above 12 characters preferably).
|
void |
setAutoRenewFlag(Long AutoRenewFlag)
Set Auto-renewal flag.
|
void |
setAutoVoucher(Long AutoVoucher)
Set Whether to use vouchers automatically.
|
void |
setCharset(String Charset)
Set Instance character set.
|
void |
setDBEngine(String DBEngine)
Set Database engines.
|
void |
setDBEngineConfig(String DBEngineConfig)
Set Configuration information of database engine in the following format:
{"$key1":"$value1", "$key2":"$value2"}
Valid values:
mssql_compatible engine:
`migrationMode`: Database mode.
|
void |
setDBKernelVersion(String DBKernelVersion)
Set PostgreSQL kernel version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
void |
setDBMajorVersion(String DBMajorVersion)
Set The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
void |
setDBNodeSet(DBNode[] DBNodeSet)
Set Deployment information of the instance node, which will display the information of each AZ when the instance node is deployed across multiple AZs.
|
void |
setDBVersion(String DBVersion)
Set Number of the major PostgreSQL community version and minor version, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
|
void |
setInstanceChargeType(String InstanceChargeType)
Set Instance billing mode.
|
void |
setInstanceCount(Long InstanceCount)
Set The number of instances to be purchased at a time.
|
void |
setKMSKeyId(String KMSKeyId)
Set KeyId of custom key, which is required if you select custom key encryption.
|
void |
setKMSRegion(String KMSRegion)
Set The region where the KMS service is enabled.
|
void |
setName(String Name)
Set Instance name, which can contain up to 60 letters, digits, hyphens, and symbols (_-).
|
void |
setNeedSupportIpv6(Long NeedSupportIpv6)
Set Whether IPv6 is supported.
|
void |
setNeedSupportTDE(Long NeedSupportTDE)
Set Whether to support TDE.
|
void |
setPeriod(Long Period)
Set Validity period in months.
|
void |
setProjectId(Long ProjectId)
Set Project ID
|
void |
setSecurityGroupIds(String[] SecurityGroupIds)
Set Security group of the instance, which can be obtained from the `sgld` field in the return value of the [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808?from_cn_redirect=1) API.
|
void |
setSpecCode(String SpecCode)
Set Purchasable code, which can be obtained from the `SpecCode` field in the return value of the [DescribeClasses](https://intl.cloud.tencent.com/document/api/409/89019?from_cn_redirect=1) API.
|
void |
setStorage(Long Storage)
Set Instance storage capacity in GB
|
void |
setSubnetId(String SubnetId)
Set VPC subnet ID in the format of `subnet-xxxxxxxx`, u200cwhich can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
|
void |
setSyncMode(String SyncMode)
Set Primary-standby sync mode.
|
void |
setTagList(Tag[] TagList)
Set The information of tags to be bound with the instance, which is left empty by default.
|
void |
setVoucherIds(String[] VoucherIds)
Set Voucher ID list.
|
void |
setVpcId(String VpcId)
Set VPC ID in the format of `vpc-xxxxxxx`.
|
void |
setZone(String Zone)
Set Primary AZ of the instance in the format of `ap-guangzhou-3`.
|
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, toJsonStringpublic CreateInstancesRequest()
public CreateInstancesRequest(CreateInstancesRequest source)
public String getZone()
public void setZone(String Zone)
Zone - Primary AZ of the instance in the format of `ap-guangzhou-3`. To support multiple AZs, add information of the primary and standby AZs in the `DBNodeSet.N` field.
The information of AZ can be obtained from the `Zone` field in the return value of the [DescribeZones](https://intl.cloud.tencent.com/document/api/409/16769?from_cn_redirect=1) API.public String getSpecCode()
public void setSpecCode(String SpecCode)
SpecCode - Purchasable code, which can be obtained from the `SpecCode` field in the return value of the [DescribeClasses](https://intl.cloud.tencent.com/document/api/409/89019?from_cn_redirect=1) API.public Long getStorage()
public void setStorage(Long Storage)
Storage - Instance storage capacity in GBpublic Long getInstanceCount()
public void setInstanceCount(Long InstanceCount)
InstanceCount - The number of instances to be purchased at a time. Value range: 1-10. To purchase more than 10 instances each time, you can make multiple calls.public Long getPeriod()
public void setPeriod(Long Period)
Period - Validity period in months.
public String getCharset()
public void setCharset(String Charset)
Charset - Instance character set. Valid values:
public String getAdminName()
public void setAdminName(String AdminName)
AdminName - Username of the instance root account, which has the following rules:
public String getAdminPassword()
public void setAdminPassword(String AdminPassword)
AdminPassword - Password of the instance root account, which must contain 8-32 characters (above 12 characters preferably). It cannot begin with "/",
and must contain the following 4 types of characters.
public String getDBMajorVersion()
public void setDBMajorVersion(String DBMajorVersion)
DBMajorVersion - The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Valid values: `10`, `11`, `12`, `13`, `14`, `15`.
When only this parameter is specified, an instance running the latest kernel version of the latest minor version will be created based on this major version.
You must pass in at least one of the following parameters: `DBMajorVersion`, `DBVersion`, DBKernelVersion`. If you don't need a minor version, just pass in `DBMajorVersion`.public String getDBVersion()
public void setDBVersion(String DBVersion)
DBVersion - Number of the major PostgreSQL community version and minor version, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
If it is specified, an instance running the latest kernel version will be created based on the community minor version.
You must pass in at least one of the following parameters: `DBMajorVersion`, `DBVersion`, DBKernelVersion`.public String getDBKernelVersion()
public void setDBKernelVersion(String DBKernelVersion)
DBKernelVersion - PostgreSQL kernel version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
PostgreSQL kernel version number. If it is specified, an instance running the specified kernel version will be created. Passing in this parameter in other scenarios is not supported.This parameter is only used to specify a kernel version, which serves no other purposes.public String getInstanceChargeType()
public void setInstanceChargeType(String InstanceChargeType)
InstanceChargeType - Instance billing mode. Valid values:
public String getVpcId()
public void setVpcId(String VpcId)
VpcId - VPC ID in the format of `vpc-xxxxxxx`. To obtain valid VPC IDs, you can log in to the console or call [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) and look for the `unVpcId` fields in the response.public String getSubnetId()
public void setSubnetId(String SubnetId)
SubnetId - VPC subnet ID in the format of `subnet-xxxxxxxx`, u200cwhich can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.public DBNode[] getDBNodeSet()
public void setDBNodeSet(DBNode[] DBNodeSet)
DBNodeSet - Deployment information of the instance node, which will display the information of each AZ when the instance node is deployed across multiple AZs.
The information of AZ can be obtained from the `Zone` field in the return value of the [DescribeZones](https://intl.cloud.tencent.com/document/api/409/16769?from_cn_redirect=1) API.public Long getAutoRenewFlag()
public void setAutoRenewFlag(Long AutoRenewFlag)
AutoRenewFlag - Auto-renewal flag. Valid values:
public Long getAutoVoucher()
public void setAutoVoucher(Long AutoVoucher)
AutoVoucher - Whether to use vouchers automatically. Valid values:
public String[] getVoucherIds()
public void setVoucherIds(String[] VoucherIds)
VoucherIds - Voucher ID list. Currently, you can specify only one voucher.public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId - Project IDpublic Long getActivityId()
public void setActivityId(Long ActivityId)
ActivityId - Campaign IDpublic String getName()
public void setName(String Name)
Name - Instance name, which can contain up to 60 letters, digits, hyphens, and symbols (_-). If this parameter is not specified, "Unnamed" will be displayed by default.public Tag[] getTagList()
public void setTagList(Tag[] TagList)
TagList - The information of tags to be bound with the instance, which is left empty by default. This parameter can be obtained from the `Tags` field in the return value of the [DescribeTags](https://intl.cloud.tencent.com/document/api/651/35316?from_cn_redirect=1) API.public String[] getSecurityGroupIds()
public void setSecurityGroupIds(String[] SecurityGroupIds)
SecurityGroupIds - Security group of the instance, which can be obtained from the `sgld` field in the return value of the [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808?from_cn_redirect=1) API. If this parameter is not specified, the default security group will be bound.public Long getNeedSupportTDE()
public void setNeedSupportTDE(Long NeedSupportTDE)
NeedSupportTDE - Whether to support TDE. Valid values:
public String getKMSKeyId()
public void setKMSKeyId(String KMSKeyId)
KMSKeyId - KeyId of custom key, which is required if you select custom key encryption. It is also the unique CMK identifier.
For more information on creating `KeyId`, see [Enabling TDE](https://www.tencentcloud.com/document/product/409/47762).public String getKMSRegion()
public void setKMSRegion(String KMSRegion)
KMSRegion - The region where the KMS service is enabled. When `KMSRegion` is left empty, the current region will be selected by default. If the current region does not support KMS, you must select another region that does.
For more information on `KMSRegion`, see [Enabling TDE](https://intl.cloud.tencent.com/document/product/409/71749?from_cn_redirect=1).public String getDBEngine()
public void setDBEngine(String DBEngine)
DBEngine - Database engines. Valid values:
public String getDBEngineConfig()
public void setDBEngineConfig(String DBEngineConfig)
DBEngineConfig - Configuration information of database engine in the following format:
{"$key1":"$value1", "$key2":"$value2"}
Valid values:
mssql_compatible engine:
public String getSyncMode()
public void setSyncMode(String SyncMode)
SyncMode - Primary-standby sync mode. Valid values:
public Long getNeedSupportIpv6()
public void setNeedSupportIpv6(Long NeedSupportIpv6)
NeedSupportIpv6 - Whether IPv6 is supported.
Copyright © 2024. All rights reserved.