public class Instance extends AbstractModel
header, skipSign| Constructor and Description |
|---|
Instance() |
Instance(Instance 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 |
getCamRoleName()
Get CAM role name.
|
Long |
getCPU()
Get Number of CPU cores of the instance; unit: core
|
String |
getCreatedTime()
Get Creation time following the `ISO8601` standard and using `UTC` time in the format of `YYYY-MM-DDThh:mm:ssZ`.
|
DataDisk[] |
getDataDisks()
Get Information of the instance data disks.
|
String |
getDedicatedClusterId()
Get Dedicated cluster ID where the instance is located.
|
Long |
getDefaultLoginPort()
Get Default login port
|
String |
getDefaultLoginUser()
Get Default login user
|
Boolean |
getDisableApiTermination()
Get Instance destruction protection flag indicates whether an instance is allowed to be deleted through an api.
|
String |
getDisasterRecoverGroupId()
Get Spread placement group ID.
|
String |
getExpiredTime()
Get Expiration time in UTC format following the `ISO8601` standard: `YYYY-MM-DDThh:mm:ssZ`.
|
GPUInfo |
getGPUInfo()
Get GPU information.
|
String |
getHpcClusterId()
Get High-performance computing cluster ID.
|
String |
getImageId()
Get `ID` of the image used to create the instance.
|
String |
getInstanceChargeType()
Get Instance billing plan.
|
String |
getInstanceId()
Get Instance `ID`
|
String |
getInstanceName()
Get Instance name
|
String |
getInstanceState()
Get Instance status.
|
String |
getInstanceType()
Get Instance model
|
InternetAccessible |
getInternetAccessible()
Get Information on instance bandwidth.
|
String[] |
getIPv6Addresses()
Get IPv6 address of the instance.
|
String |
getIsolatedSource()
Get Instance isolation type.
|
String |
getLatestOperation()
Get Last operation of the instance, such as StopInstances or ResetInstance.
|
String |
getLatestOperationErrorMsg()
Get Latest operation errors of the instance.
|
String |
getLatestOperationRequestId()
Get Unique request ID for the last operation of the instance.
|
String |
getLatestOperationState()
Get The latest operation status of the instance.
|
String |
getLicenseType()
Get Instance OS license type.
|
LoginSettings |
getLoginSettings()
Get Login settings of the instance.
|
Long |
getMemory()
Get Instance memory capacity.
|
Metadata |
getMetadata()
Get Custom metadata.
|
String |
getOsName()
Get Operating system name.
|
Placement |
getPlacement()
Get Location of the instance
|
String[] |
getPrivateIpAddresses()
Get List of private IPs of the instance's primary ENI.
|
String[] |
getPublicIpAddresses()
Get List of public IPs of the instance's primary ENI.
|
String[] |
getPublicIPv6Addresses()
Get Specifies the public IPv6 address bound to the instance.
|
String[] |
getRdmaIpAddresses()
Get IP list of HPC cluster.
|
String |
getRenewFlag()
Get AUTO-Renewal flag.
|
String |
getRestrictState()
Get Instance business status.
|
String[] |
getSecurityGroupIds()
Get Security groups to which the instance belongs.
|
String |
getStopChargingMode()
Get Shutdown billing mode of an instance.
|
SystemDisk |
getSystemDisk()
Get Information on the system disk of the instance
|
Tag[] |
getTags()
Get List of tags associated with the instance.
|
String |
getUuid()
Get Globally unique ID of the instance.
|
VirtualPrivateCloud |
getVirtualPrivateCloud()
Get Information on the VPC where the instance resides.
|
void |
setCamRoleName(String CamRoleName)
Set CAM role name.
|
void |
setCPU(Long CPU)
Set Number of CPU cores of the instance; unit: core
|
void |
setCreatedTime(String CreatedTime)
Set Creation time following the `ISO8601` standard and using `UTC` time in the format of `YYYY-MM-DDThh:mm:ssZ`.
|
void |
setDataDisks(DataDisk[] DataDisks)
Set Information of the instance data disks.
|
void |
setDedicatedClusterId(String DedicatedClusterId)
Set Dedicated cluster ID where the instance is located.
|
void |
setDefaultLoginPort(Long DefaultLoginPort)
Set Default login port
|
void |
setDefaultLoginUser(String DefaultLoginUser)
Set Default login user
|
void |
setDisableApiTermination(Boolean DisableApiTermination)
Set Instance destruction protection flag indicates whether an instance is allowed to be deleted through an api.
|
void |
setDisasterRecoverGroupId(String DisasterRecoverGroupId)
Set Spread placement group ID.
|
void |
setExpiredTime(String ExpiredTime)
Set Expiration time in UTC format following the `ISO8601` standard: `YYYY-MM-DDThh:mm:ssZ`.
|
void |
setGPUInfo(GPUInfo GPUInfo)
Set GPU information.
|
void |
setHpcClusterId(String HpcClusterId)
Set High-performance computing cluster ID.
|
void |
setImageId(String ImageId)
Set `ID` of the image used to create the instance.
|
void |
setInstanceChargeType(String InstanceChargeType)
Set Instance billing plan.
|
void |
setInstanceId(String InstanceId)
Set Instance `ID`
|
void |
setInstanceName(String InstanceName)
Set Instance name
|
void |
setInstanceState(String InstanceState)
Set Instance status.
|
void |
setInstanceType(String InstanceType)
Set Instance model
|
void |
setInternetAccessible(InternetAccessible InternetAccessible)
Set Information on instance bandwidth.
|
void |
setIPv6Addresses(String[] IPv6Addresses)
Set IPv6 address of the instance.
|
void |
setIsolatedSource(String IsolatedSource)
Set Instance isolation type.
|
void |
setLatestOperation(String LatestOperation)
Set Last operation of the instance, such as StopInstances or ResetInstance.
|
void |
setLatestOperationErrorMsg(String LatestOperationErrorMsg)
Set Latest operation errors of the instance.
|
void |
setLatestOperationRequestId(String LatestOperationRequestId)
Set Unique request ID for the last operation of the instance.
|
void |
setLatestOperationState(String LatestOperationState)
Set The latest operation status of the instance.
|
void |
setLicenseType(String LicenseType)
Set Instance OS license type.
|
void |
setLoginSettings(LoginSettings LoginSettings)
Set Login settings of the instance.
|
void |
setMemory(Long Memory)
Set Instance memory capacity.
|
void |
setMetadata(Metadata Metadata)
Set Custom metadata.
|
void |
setOsName(String OsName)
Set Operating system name.
|
void |
setPlacement(Placement Placement)
Set Location of the instance
|
void |
setPrivateIpAddresses(String[] PrivateIpAddresses)
Set List of private IPs of the instance's primary ENI.
|
void |
setPublicIpAddresses(String[] PublicIpAddresses)
Set List of public IPs of the instance's primary ENI.
|
void |
setPublicIPv6Addresses(String[] PublicIPv6Addresses)
Set Specifies the public IPv6 address bound to the instance.
|
void |
setRdmaIpAddresses(String[] RdmaIpAddresses)
Set IP list of HPC cluster.
|
void |
setRenewFlag(String RenewFlag)
Set AUTO-Renewal flag.
|
void |
setRestrictState(String RestrictState)
Set Instance business status.
|
void |
setSecurityGroupIds(String[] SecurityGroupIds)
Set Security groups to which the instance belongs.
|
void |
setStopChargingMode(String StopChargingMode)
Set Shutdown billing mode of an instance.
|
void |
setSystemDisk(SystemDisk SystemDisk)
Set Information on the system disk of the instance
|
void |
setTags(Tag[] Tags)
Set List of tags associated with the instance.
|
void |
setUuid(String Uuid)
Set Globally unique ID of the instance.
|
void |
setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
Set Information on the VPC where the instance resides.
|
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 Instance()
public Instance(Instance source)
public Placement getPlacement()
public void setPlacement(Placement Placement)
Placement - Location of the instancepublic String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId - Instance `ID`public String getInstanceType()
public void setInstanceType(String InstanceType)
InstanceType - Instance modelpublic Long getCPU()
public void setCPU(Long CPU)
CPU - Number of CPU cores of the instance; unit: corepublic Long getMemory()
public void setMemory(Long Memory)
Memory - Instance memory capacity. unit: GiB.public String getRestrictState()
public void setRestrictState(String RestrictState)
RestrictState - Instance business status. valid values:public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName - Instance namepublic String getInstanceChargeType()
public void setInstanceChargeType(String InstanceChargeType)
InstanceChargeType - Instance billing plan. Valid values:public SystemDisk getSystemDisk()
public void setSystemDisk(SystemDisk SystemDisk)
SystemDisk - Information on the system disk of the instancepublic DataDisk[] getDataDisks()
public void setDataDisks(DataDisk[] DataDisks)
DataDisks - Information of the instance data disks.public String[] getPrivateIpAddresses()
public void setPrivateIpAddresses(String[] PrivateIpAddresses)
PrivateIpAddresses - List of private IPs of the instance's primary ENI.public String[] getPublicIpAddresses()
public void setPublicIpAddresses(String[] PublicIpAddresses)
PublicIpAddresses - List of public IPs of the instance's primary ENI.
Note: This field may return null, indicating that no valid value is found.public InternetAccessible getInternetAccessible()
public void setInternetAccessible(InternetAccessible InternetAccessible)
InternetAccessible - Information on instance bandwidth.public VirtualPrivateCloud getVirtualPrivateCloud()
public void setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
VirtualPrivateCloud - Information on the VPC where the instance resides.public String getImageId()
public void setImageId(String ImageId)
ImageId - `ID` of the image used to create the instance.public String getRenewFlag()
public void setRenewFlag(String RenewFlag)
RenewFlag - AUTO-Renewal flag. valid values:public String getCreatedTime()
public void setCreatedTime(String CreatedTime)
CreatedTime - Creation time following the `ISO8601` standard and using `UTC` time in the format of `YYYY-MM-DDThh:mm:ssZ`.public String getExpiredTime()
public void setExpiredTime(String ExpiredTime)
ExpiredTime - Expiration time in UTC format following the `ISO8601` standard: `YYYY-MM-DDThh:mm:ssZ`. Note: this parameter is `null` for postpaid instances.public String getOsName()
public void setOsName(String OsName)
OsName - Operating system name.public String[] getSecurityGroupIds()
public void setSecurityGroupIds(String[] SecurityGroupIds)
SecurityGroupIds - Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response.public LoginSettings getLoginSettings()
public void setLoginSettings(LoginSettings LoginSettings)
LoginSettings - Login settings of the instance. Currently only the key associated with the instance is returned.public String getInstanceState()
public void setInstanceState(String InstanceState)
InstanceState - Instance status. for specific status types, see the instance status table (https://www.tencentcloud.comom/document/api/213/15753?from_cn_redirect=1#InstanceStatus).public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags - List of tags associated with the instance.public String getStopChargingMode()
public void setStopChargingMode(String StopChargingMode)
StopChargingMode - Shutdown billing mode of an instance.
Valid values: public String getUuid()
public void setUuid(String Uuid)
Uuid - Globally unique ID of the instance.public String getLatestOperation()
public void setLatestOperation(String LatestOperation)
LatestOperation - Last operation of the instance, such as StopInstances or ResetInstance.public String getLatestOperationState()
public void setLatestOperationState(String LatestOperationState)
LatestOperationState - The latest operation status of the instance. valid values:public String getLatestOperationRequestId()
public void setLatestOperationRequestId(String LatestOperationRequestId)
LatestOperationRequestId - Unique request ID for the last operation of the instance.public String getDisasterRecoverGroupId()
public void setDisasterRecoverGroupId(String DisasterRecoverGroupId)
DisasterRecoverGroupId - Spread placement group ID.public String[] getIPv6Addresses()
public void setIPv6Addresses(String[] IPv6Addresses)
IPv6Addresses - IPv6 address of the instance.
Note: this field may return null, indicating that no valid value is obtained.public String getCamRoleName()
public void setCamRoleName(String CamRoleName)
CamRoleName - CAM role name.
Note: this field may return null, indicating that no valid value is obtained.public String getHpcClusterId()
public void setHpcClusterId(String HpcClusterId)
HpcClusterId - High-performance computing cluster ID.public String[] getRdmaIpAddresses()
public void setRdmaIpAddresses(String[] RdmaIpAddresses)
RdmaIpAddresses - IP list of HPC cluster.
Note: this field may return null, indicating that no valid value was found.public String getDedicatedClusterId()
public void setDedicatedClusterId(String DedicatedClusterId)
DedicatedClusterId - Dedicated cluster ID where the instance is located.public String getIsolatedSource()
public void setIsolatedSource(String IsolatedSource)
IsolatedSource - Instance isolation type. valid values:public GPUInfo getGPUInfo()
public void setGPUInfo(GPUInfo GPUInfo)
GPUInfo - GPU information. if it is a gpu type instance, this value will be returned. for other type instances, it does not return.public String getLicenseType()
public void setLicenseType(String LicenseType)
LicenseType - Instance OS license type. Default value: `TencentCloud`public Boolean getDisableApiTermination()
public void setDisableApiTermination(Boolean DisableApiTermination)
DisableApiTermination - Instance destruction protection flag indicates whether an instance is allowed to be deleted through an api. value ranges from:public String getDefaultLoginUser()
public void setDefaultLoginUser(String DefaultLoginUser)
DefaultLoginUser - Default login userpublic Long getDefaultLoginPort()
public void setDefaultLoginPort(Long DefaultLoginPort)
DefaultLoginPort - Default login portpublic String getLatestOperationErrorMsg()
public void setLatestOperationErrorMsg(String LatestOperationErrorMsg)
LatestOperationErrorMsg - Latest operation errors of the instance.
Note: This field may return `null`, indicating that no valid values can be obtained.public Metadata getMetadata()
public void setMetadata(Metadata Metadata)
Metadata - Custom metadata. this parameter corresponds to the metadata information specified when creating a CVM. **note: in beta test**.public String[] getPublicIPv6Addresses()
public void setPublicIPv6Addresses(String[] PublicIPv6Addresses)
PublicIPv6Addresses - Specifies the public IPv6 address bound to the instance.Copyright © 2025. All rights reserved.