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, with the following specifications:
The username must consist of 1-16 characters, which can be letters, digits, or underscores.
It cannot be postgres.
It cannot start with digits or 'pg_'.
All rules are case-insensitive.
|
String |
getAdminPassword()
Get Password for the instance root account username, with a length of 8-32 characters.
|
Long |
getAutoRenewFlag()
Get Renewal Flag:
`0`: manual renewal
`1`: auto-renewal
Default value: 0
|
Long |
getAutoVoucher()
Get Whether to automatically use coupons:
`0`: no
`1`: yes
Default value: 0
|
String |
getCharset()
Get Instance character set, which currently supports only:
UTF8
LATIN1
|
String |
getDBEngine()
Get Database engine, which supports:
`postgresql`: TencentDB for PostgreSQL
`mssql_compatible`: MSSQL compatible - TencentDB for PostgreSQL
Default value: `postgresql`
|
String |
getDBEngineConfig()
Get Configuration information for the database engine, and the configuration format is as follows:
{"$key1":"$value1", "$key2":"$value2"}
Supported engines include:
mssql_compatible engine:
migrationMode: Database mode, an optional parameter, and its valid values are: single-db (single database schema) and multi-db (multiple database schema).
|
String |
getDBKernelVersion()
Get PostgreSQL kernel version number.
|
String |
getDBMajorVersion()
Get The major version number of PostgreSQL (this parameter is currently required), and the version information can be obtained from [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1).
|
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 PostgreSQL community major version + minor version number.
|
String |
getInstanceChargeType()
Get Instance billing type, which currently supports:
PREPAID: Prepaid, i.e., monthly subscription
POSTPAID_BY_HOUR: Pay-as-you-go, i.e., pay by consumption
Default value: PREPAID
|
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 support to IPv6 is required:
`0`: no
`1`: yes
Default value: 0
|
Long |
getNeedSupportTDE()
Get Whether data transparent encryption is required:
`0`: no
`1`: yes
Default value: 0See [Overview of Data Transparent Encryption](https://intl.cloud.tencent.com/document/product/409/71748?from_cn_redirect=1).
|
Long |
getPeriod()
Get Purchase duration, 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 (this parameter is currently required).
|
String |
getSyncMode()
Get Primary-standby sync mode, which supports:
Semi-sync: Semi-sync
Async: Asynchronous
Default value for the primary instance: Semi-sync
Default value for the read-only instance: Async
|
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-xxxxxxxx (this parameter is currently required).
|
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, with the following specifications:
The username must consist of 1-16 characters, which can be letters, digits, or underscores.
It cannot be postgres.
It cannot start with digits or 'pg_'.
All rules are case-insensitive.
|
void |
setAdminPassword(String AdminPassword)
Set Password for the instance root account username, with a length of 8-32 characters.
|
void |
setAutoRenewFlag(Long AutoRenewFlag)
Set Renewal Flag:
`0`: manual renewal
`1`: auto-renewal
Default value: 0
|
void |
setAutoVoucher(Long AutoVoucher)
Set Whether to automatically use coupons:
`0`: no
`1`: yes
Default value: 0
|
void |
setCharset(String Charset)
Set Instance character set, which currently supports only:
UTF8
LATIN1
|
void |
setDBEngine(String DBEngine)
Set Database engine, which supports:
`postgresql`: TencentDB for PostgreSQL
`mssql_compatible`: MSSQL compatible - TencentDB for PostgreSQL
Default value: `postgresql`
|
void |
setDBEngineConfig(String DBEngineConfig)
Set Configuration information for the database engine, and the configuration format is as follows:
{"$key1":"$value1", "$key2":"$value2"}
Supported engines include:
mssql_compatible engine:
migrationMode: Database mode, an optional parameter, and its valid values are: single-db (single database schema) and multi-db (multiple database schema).
|
void |
setDBKernelVersion(String DBKernelVersion)
Set PostgreSQL kernel version number.
|
void |
setDBMajorVersion(String DBMajorVersion)
Set The major version number of PostgreSQL (this parameter is currently required), and the version information can be obtained from [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1).
|
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 PostgreSQL community major version + minor version number.
|
void |
setInstanceChargeType(String InstanceChargeType)
Set Instance billing type, which currently supports:
PREPAID: Prepaid, i.e., monthly subscription
POSTPAID_BY_HOUR: Pay-as-you-go, i.e., pay by consumption
Default value: PREPAID
|
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 support to IPv6 is required:
`0`: no
`1`: yes
Default value: 0
|
void |
setNeedSupportTDE(Long NeedSupportTDE)
Set Whether data transparent encryption is required:
`0`: no
`1`: yes
Default value: 0See [Overview of Data Transparent Encryption](https://intl.cloud.tencent.com/document/product/409/71748?from_cn_redirect=1).
|
void |
setPeriod(Long Period)
Set Purchase duration, 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 (this parameter is currently required).
|
void |
setSyncMode(String SyncMode)
Set Primary-standby sync mode, which supports:
Semi-sync: Semi-sync
Async: Asynchronous
Default value for the primary instance: Semi-sync
Default value for the read-only instance: Async
|
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-xxxxxxxx (this parameter is currently required).
|
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 - Purchase duration, in months.
public String getCharset()
public void setCharset(String Charset)
Charset - Instance character set, which currently supports only:
public String getAdminName()
public void setAdminName(String AdminName)
AdminName - Username of the instance root account, with the following specifications:
public String getAdminPassword()
public void setAdminPassword(String AdminPassword)
AdminPassword - Password for the instance root account username, with a length of 8-32 characters. It is recommended to use a password of more than 12 characters and it cannot start with "/".
It must include the following four types of characters:
public String getDBMajorVersion()
public void setDBMajorVersion(String DBMajorVersion)
DBMajorVersion - The major version number of PostgreSQL (this parameter is currently required), and the version information can be obtained from [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1). Currently major versions `10`, `11`, `12`, `13`, `14`, and `15` are supported. For details, see [Kernel Version Overview](https://intl.cloud.tencent.com/document/product/409/67018).
When this parameter is entered, an instance running the latest kernel version of the latest minor version will be created based on this major version number.public String getDBVersion()
public void setDBVersion(String DBVersion)
DBVersion - PostgreSQL community major version + minor version number.
It's generally not recommended to pass in this parameter. If needed, only the latest minor version number under the current major version can be passed.public String getDBKernelVersion()
public void setDBKernelVersion(String DBKernelVersion)
DBKernelVersion - PostgreSQL kernel version number.
It's generally not recommended to pass in this parameter. If needed, only the latest kernel version number under the current major version can be passed.public String getInstanceChargeType()
public void setInstanceChargeType(String InstanceChargeType)
InstanceChargeType - Instance billing type, which currently supports:
public String getVpcId()
public void setVpcId(String VpcId)
VpcId - VPC ID, in the format of vpc-xxxxxxxx (this parameter is currently required). A valid VpcId can be obtained by logging into the console; it can also be obtained from the unVpcId field in the return value of calling of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.public String getSubnetId()
public void setSubnetId(String SubnetId)
SubnetId - VPC subnet ID, in the format of subnet-xxxxxxxx (this parameter is currently required). A valid VPC subnet ID can be obtained by logging into the console; it can also be obtained from the unSubnetId field in the return value of calling 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 - Renewal Flag:
public Long getAutoVoucher()
public void setAutoVoucher(Long AutoVoucher)
AutoVoucher - Whether to automatically use coupons:
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 data transparent encryption is required:
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 engine, which supports:
public String getDBEngineConfig()
public void setDBEngineConfig(String DBEngineConfig)
DBEngineConfig - Configuration information for the database engine, and the configuration format is as follows:
{"$key1":"$value1", "$key2":"$value2"}
Supported engines include:
mssql_compatible engine:
public String getSyncMode()
public void setSyncMode(String SyncMode)
SyncMode - Primary-standby sync mode, which supports:
public Long getNeedSupportIpv6()
public void setNeedSupportIpv6(Long NeedSupportIpv6)
NeedSupportIpv6 - Whether support to IPv6 is required:
Copyright © 2025. All rights reserved.