public class DBInstance extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
DBInstance()  | 
DBInstance(DBInstance 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 | 
getAppId()
Get Application ID of instance 
 | 
Long | 
getAutoRenewFlag()
Get Auto-renewal flag. 
 | 
Long | 
getCpu()
Get Number of CPU cores of instance 
 | 
String | 
getCreateTime()
Get Instance creation time in the format of `2006-01-02 15:04:05` 
 | 
String | 
getDbEngine()
Get Database engine
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getDbVersion()
Get Database version
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getDbVersionId()
Get Database version
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getDcnDstNum()
Get The number of DCN disaster recovery instances
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getDcnFlag()
Get DCN type. 
 | 
Long | 
getDcnStatus()
Get DCN status. 
 | 
String | 
getExclusterId()
Get Dedicated cluster ID. 
 | 
Long | 
getId()
Get Numeric ID of instance (this field is obsolete and should not be depended on) 
 | 
String | 
getInstanceId()
Get Instance ID, which uniquely identifies a TDSQL instance 
 | 
String | 
getInstanceName()
Get Customizable instance name 
 | 
Long | 
getInstanceType()
Get Instance type. 
 | 
Long | 
getIpv6Flag()
Get Indicates whether the instance uses IPv6
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getIsAuditSupported()
Get Whether the instance supports audit. 
 | 
Long | 
getIsEncryptSupported()
Get Whether data encryption is supported. 
 | 
Long | 
getIsTmp()
Get Whether it is a temp instance. 
 | 
Long | 
getLocker()
Get Async task flow ID when an async task is in progress on an instance
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getMachine()
Get Model 
 | 
Long | 
getMemory()
Get Instance memory size in GB 
 | 
Long | 
getNodeCount()
Get Number of nodes. 
 | 
String | 
getOriginSerialId()
Get Original ID of instance (this field is obsolete and should not be depended on) 
 | 
String | 
getPaymode()
Get Billing mode
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getPeriodEndTime()
Get Instance expiration time in the format of `2006-01-02 15:04:05` 
 | 
Long | 
getPid()
Get Product type ID 
 | 
Long | 
getProjectId()
Get Project ID of instance 
 | 
Long | 
getQps()
Get Maximum QPS value 
 | 
String | 
getRegion()
Get Instance region name, such as ap-shanghai 
 | 
ResourceTag[] | 
getResourceTags()
Get Instance tag information
Note: this field may return `null`, indicating that no valid values can be obtained. 
 | 
Long | 
getStatus()
Get Instance status. 
 | 
String | 
getStatusDesc()
Get Current instance running status description
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getStorage()
Get Instance storage capacity in GB 
 | 
Long | 
getSubnetId()
Get Subnet ID, which is 0 if the basic network is used 
 | 
String | 
getTdsqlVersion()
Get TDSQL version information 
 | 
String | 
getUin()
Get Instance account 
 | 
String | 
getUniqueSubnetId()
Get VPC subnet ID in string type 
 | 
String | 
getUniqueVpcId()
Get VPC ID in string type 
 | 
String | 
getUpdateTime()
Get Last updated time of instance in the format of `2006-01-02 15:04:05` 
 | 
String | 
getVip()
Get Private IP address 
 | 
String | 
getVipv6()
Get Private network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getVpcId()
Get VPC ID, which is 0 if the basic network is used 
 | 
Long | 
getVport()
Get Private network port 
 | 
String | 
getWanDomain()
Get Domain name for public network access, which can be resolved by the public network 
 | 
Long | 
getWanPort()
Get Public network port 
 | 
Long | 
getWanPortIpv6()
Get Public network IPv6 port
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getWanStatus()
Get Public network access status. 
 | 
Long | 
getWanStatusIpv6()
Get Public network IPv6 status
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getWanVip()
Get Public IP address, which can be accessed over the public network 
 | 
String | 
getWanVipv6()
Get Public network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getZone()
Get Instance AZ name, such as ap-guangzhou-1 
 | 
void | 
setAppId(Long AppId)
Set Application ID of instance 
 | 
void | 
setAutoRenewFlag(Long AutoRenewFlag)
Set Auto-renewal flag. 
 | 
void | 
setCpu(Long Cpu)
Set Number of CPU cores of instance 
 | 
void | 
setCreateTime(String CreateTime)
Set Instance creation time in the format of `2006-01-02 15:04:05` 
 | 
void | 
setDbEngine(String DbEngine)
Set Database engine
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setDbVersion(String DbVersion)
Set Database version
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setDbVersionId(String DbVersionId)
Set Database version
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setDcnDstNum(Long DcnDstNum)
Set The number of DCN disaster recovery instances
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setDcnFlag(Long DcnFlag)
Set DCN type. 
 | 
void | 
setDcnStatus(Long DcnStatus)
Set DCN status. 
 | 
void | 
setExclusterId(String ExclusterId)
Set Dedicated cluster ID. 
 | 
void | 
setId(Long Id)
Set Numeric ID of instance (this field is obsolete and should not be depended on) 
 | 
void | 
setInstanceId(String InstanceId)
Set Instance ID, which uniquely identifies a TDSQL instance 
 | 
void | 
setInstanceName(String InstanceName)
Set Customizable instance name 
 | 
void | 
setInstanceType(Long InstanceType)
Set Instance type. 
 | 
void | 
setIpv6Flag(Long Ipv6Flag)
Set Indicates whether the instance uses IPv6
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setIsAuditSupported(Long IsAuditSupported)
Set Whether the instance supports audit. 
 | 
void | 
setIsEncryptSupported(Long IsEncryptSupported)
Set Whether data encryption is supported. 
 | 
void | 
setIsTmp(Long IsTmp)
Set Whether it is a temp instance. 
 | 
void | 
setLocker(Long Locker)
Set Async task flow ID when an async task is in progress on an instance
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setMachine(String Machine)
Set Model 
 | 
void | 
setMemory(Long Memory)
Set Instance memory size in GB 
 | 
void | 
setNodeCount(Long NodeCount)
Set Number of nodes. 
 | 
void | 
setOriginSerialId(String OriginSerialId)
Set Original ID of instance (this field is obsolete and should not be depended on) 
 | 
void | 
setPaymode(String Paymode)
Set Billing mode
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setPeriodEndTime(String PeriodEndTime)
Set Instance expiration time in the format of `2006-01-02 15:04:05` 
 | 
void | 
setPid(Long Pid)
Set Product type ID 
 | 
void | 
setProjectId(Long ProjectId)
Set Project ID of instance 
 | 
void | 
setQps(Long Qps)
Set Maximum QPS value 
 | 
void | 
setRegion(String Region)
Set Instance region name, such as ap-shanghai 
 | 
void | 
setResourceTags(ResourceTag[] ResourceTags)
Set Instance tag information
Note: this field may return `null`, indicating that no valid values can be obtained. 
 | 
void | 
setStatus(Long Status)
Set Instance status. 
 | 
void | 
setStatusDesc(String StatusDesc)
Set Current instance running status description
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setStorage(Long Storage)
Set Instance storage capacity in GB 
 | 
void | 
setSubnetId(Long SubnetId)
Set Subnet ID, which is 0 if the basic network is used 
 | 
void | 
setTdsqlVersion(String TdsqlVersion)
Set TDSQL version information 
 | 
void | 
setUin(String Uin)
Set Instance account 
 | 
void | 
setUniqueSubnetId(String UniqueSubnetId)
Set VPC subnet ID in string type 
 | 
void | 
setUniqueVpcId(String UniqueVpcId)
Set VPC ID in string type 
 | 
void | 
setUpdateTime(String UpdateTime)
Set Last updated time of instance in the format of `2006-01-02 15:04:05` 
 | 
void | 
setVip(String Vip)
Set Private IP address 
 | 
void | 
setVipv6(String Vipv6)
Set Private network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setVpcId(Long VpcId)
Set VPC ID, which is 0 if the basic network is used 
 | 
void | 
setVport(Long Vport)
Set Private network port 
 | 
void | 
setWanDomain(String WanDomain)
Set Domain name for public network access, which can be resolved by the public network 
 | 
void | 
setWanPort(Long WanPort)
Set Public network port 
 | 
void | 
setWanPortIpv6(Long WanPortIpv6)
Set Public network IPv6 port
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setWanStatus(Long WanStatus)
Set Public network access status. 
 | 
void | 
setWanStatusIpv6(Long WanStatusIpv6)
Set Public network IPv6 status
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setWanVip(String WanVip)
Set Public IP address, which can be accessed over the public network 
 | 
void | 
setWanVipv6(String WanVipv6)
Set Public network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setZone(String Zone)
Set Instance AZ name, such as ap-guangzhou-1 
 | 
void | 
toMap(HashMap<String,String> map,
     String prefix)
Internal implementation, normal users should not use it. 
 | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic DBInstance()
public DBInstance(DBInstance source)
public String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId - Instance ID, which uniquely identifies a TDSQL instancepublic String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName - Customizable instance namepublic Long getAppId()
public void setAppId(Long AppId)
AppId - Application ID of instancepublic Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId - Project ID of instancepublic String getRegion()
public void setRegion(String Region)
Region - Instance region name, such as ap-shanghaipublic String getZone()
public void setZone(String Zone)
Zone - Instance AZ name, such as ap-guangzhou-1public Long getVpcId()
public void setVpcId(Long VpcId)
VpcId - VPC ID, which is 0 if the basic network is usedpublic Long getSubnetId()
public void setSubnetId(Long SubnetId)
SubnetId - Subnet ID, which is 0 if the basic network is usedpublic Long getStatus()
public void setStatus(Long Status)
Status - Instance status. Valid values: `0` (creating), `1` (running task), `2` (running), `3` (uninitialized), `-1` (isolated), `4` (initializing), `5` (eliminating), `6` (restarting), `7` (migrating data)public String getVip()
public void setVip(String Vip)
Vip - Private IP addresspublic Long getVport()
public void setVport(Long Vport)
Vport - Private network portpublic String getWanDomain()
public void setWanDomain(String WanDomain)
WanDomain - Domain name for public network access, which can be resolved by the public networkpublic String getWanVip()
public void setWanVip(String WanVip)
WanVip - Public IP address, which can be accessed over the public networkpublic Long getWanPort()
public void setWanPort(Long WanPort)
WanPort - Public network portpublic String getCreateTime()
public void setCreateTime(String CreateTime)
CreateTime - Instance creation time in the format of `2006-01-02 15:04:05`public String getUpdateTime()
public void setUpdateTime(String UpdateTime)
UpdateTime - Last updated time of instance in the format of `2006-01-02 15:04:05`public Long getAutoRenewFlag()
public void setAutoRenewFlag(Long AutoRenewFlag)
AutoRenewFlag - Auto-renewal flag. 0: no, 1: yespublic String getPeriodEndTime()
public void setPeriodEndTime(String PeriodEndTime)
PeriodEndTime - Instance expiration time in the format of `2006-01-02 15:04:05`public String getUin()
public void setUin(String Uin)
Uin - Instance accountpublic String getTdsqlVersion()
public void setTdsqlVersion(String TdsqlVersion)
TdsqlVersion - TDSQL version informationpublic Long getMemory()
public void setMemory(Long Memory)
Memory - Instance memory size in GBpublic Long getStorage()
public void setStorage(Long Storage)
Storage - Instance storage capacity in GBpublic String getUniqueVpcId()
public void setUniqueVpcId(String UniqueVpcId)
UniqueVpcId - VPC ID in string typepublic String getUniqueSubnetId()
public void setUniqueSubnetId(String UniqueSubnetId)
UniqueSubnetId - VPC subnet ID in string typepublic String getOriginSerialId()
public void setOriginSerialId(String OriginSerialId)
OriginSerialId - Original ID of instance (this field is obsolete and should not be depended on)public Long getNodeCount()
public void setNodeCount(Long NodeCount)
NodeCount - Number of nodes. 2: one master and one slave, 3: one master and two slavespublic Long getIsTmp()
public void setIsTmp(Long IsTmp)
IsTmp - Whether it is a temp instance. 0: no, non-zero value: yespublic String getExclusterId()
public void setExclusterId(String ExclusterId)
ExclusterId - Dedicated cluster ID. If this parameter is empty, the instance is a general instancepublic Long getId()
public void setId(Long Id)
Id - Numeric ID of instance (this field is obsolete and should not be depended on)public Long getPid()
public void setPid(Long Pid)
Pid - Product type IDpublic Long getQps()
public void setQps(Long Qps)
Qps - Maximum QPS valuepublic String getPaymode()
public void setPaymode(String Paymode)
Paymode - Billing mode
Note: this field may return null, indicating that no valid values can be obtained.public Long getLocker()
public void setLocker(Long Locker)
Locker - Async task flow ID when an async task is in progress on an instance
Note: this field may return null, indicating that no valid values can be obtained.public String getStatusDesc()
public void setStatusDesc(String StatusDesc)
StatusDesc - Current instance running status description
Note: this field may return null, indicating that no valid values can be obtained.public Long getWanStatus()
public void setWanStatus(Long WanStatus)
WanStatus - Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enablingpublic Long getIsAuditSupported()
public void setIsAuditSupported(Long IsAuditSupported)
IsAuditSupported - Whether the instance supports audit. 1: yes, 0: nopublic String getMachine()
public void setMachine(String Machine)
Machine - Modelpublic Long getIsEncryptSupported()
public void setIsEncryptSupported(Long IsEncryptSupported)
IsEncryptSupported - Whether data encryption is supported. 1: yes, 0: nopublic Long getCpu()
public void setCpu(Long Cpu)
Cpu - Number of CPU cores of instancepublic Long getIpv6Flag()
public void setIpv6Flag(Long Ipv6Flag)
Ipv6Flag - Indicates whether the instance uses IPv6
Note: this field may return null, indicating that no valid values can be obtained.public String getVipv6()
public void setVipv6(String Vipv6)
Vipv6 - Private network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained.public String getWanVipv6()
public void setWanVipv6(String WanVipv6)
WanVipv6 - Public network IPv6 address
Note: this field may return null, indicating that no valid values can be obtained.public Long getWanPortIpv6()
public void setWanPortIpv6(Long WanPortIpv6)
WanPortIpv6 - Public network IPv6 port
Note: this field may return null, indicating that no valid values can be obtained.public Long getWanStatusIpv6()
public void setWanStatusIpv6(Long WanStatusIpv6)
WanStatusIpv6 - Public network IPv6 status
Note: this field may return null, indicating that no valid values can be obtained.public String getDbEngine()
public void setDbEngine(String DbEngine)
DbEngine - Database engine
Note: this field may return null, indicating that no valid values can be obtained.public String getDbVersion()
public void setDbVersion(String DbVersion)
DbVersion - Database version
Note: this field may return null, indicating that no valid values can be obtained.public Long getDcnFlag()
public void setDcnFlag(Long DcnFlag)
DcnFlag - DCN type. Valid values: 0 (null), 1 (primary instance), 2 (disaster recovery instance)
Note: this field may return null, indicating that no valid values can be obtained.public Long getDcnStatus()
public void setDcnStatus(Long DcnStatus)
DcnStatus - DCN status. Valid values: 0 (null), 1 (creating), 2 (syncing), 3 (disconnected)
Note: this field may return null, indicating that no valid values can be obtained.public Long getDcnDstNum()
public void setDcnDstNum(Long DcnDstNum)
DcnDstNum - The number of DCN disaster recovery instances
Note: this field may return null, indicating that no valid values can be obtained.public Long getInstanceType()
public void setInstanceType(Long InstanceType)
InstanceType - Instance type. Valid values: `1` (dedicated primary instance), `2` (primary instance), `3` (disaster recovery instance), and `4` (dedicated disaster recovery instance).
Note: this field may return null, indicating that no valid values can be obtained.public ResourceTag[] getResourceTags()
public void setResourceTags(ResourceTag[] ResourceTags)
ResourceTags - Instance tag information
Note: this field may return `null`, indicating that no valid values can be obtained.public String getDbVersionId()
public void setDbVersionId(String DbVersionId)
DbVersionId - Database version
Note: This field may return null, indicating that no valid values can be obtained.Copyright © 2025. All rights reserved.